Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: change link as plaintext if API is excluded #10300

Merged
merged 2 commits into from
Oct 19, 2024

Conversation

filzrev
Copy link
Contributor

@filzrev filzrev commented Oct 19, 2024

This PR intended to fix problem reported at #10287.

When class is excluded. link target document is not exists.
So link to excluded symbol should be rendered as plain text.

What's changed in this PR
It needs SymbolFilter::IncludeApi instance to check specific symbol is excluded or not.
So it need to pass SymbolFilter instance to API that generate URL.

  • Add SymbolFilter filter parameter to several APIs.
  • Change url generation logics to check filter.IncludeApi(symbol) and set null when symbol is excluded.
  • Remove SymbolVisitorAdapter adapter parameter (that seems not be used).

Test
Tested on local environment with following output formats.

  • mref
  • markdown
  • apiPage

@yufeih yufeih merged commit 512fdf5 into dotnet:main Oct 19, 2024
7 checks passed
@yufeih
Copy link
Contributor

yufeih commented Oct 19, 2024

Thank you for the fix!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug-fix Makes the pull request to appear in "Bug Fixes" section of the next release note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants