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

FR: Show [Obsolete] status and message in documentation view #173

Open
mindsolve opened this issue Jun 6, 2022 · 3 comments
Open

FR: Show [Obsolete] status and message in documentation view #173

mindsolve opened this issue Jun 6, 2022 · 3 comments

Comments

@mindsolve
Copy link

This is an extension to the FR #167 to also display the [Obsolete] status and message in documentation view, not only in the diff.
I would like to be able to directly see whether an API is deprecated.

@mindsolve
Copy link
Author

I have created a proof-of-concept in my fork, based on PR #171 (adding obsolete status to the diff view): https://github.com/mindsolve/FuGetGallery/tree/feature/173-obsolete-status-in-doc-view

I would appreciate feedback before opening the PR, especially with the design.

Feature status of POC:

Screenshots:

  • Example of member with documentation and obsoletion message:
    grafik
  • Same snippet in dark mode:
    grafik
  • Example of member without documentation and with empty [Obsolete] constructor
    grafik

jamesmcroft added a commit to jamesmcroft/FuGetGallery that referenced this issue Jun 18, 2022
@jamesmcroft
Copy link

jamesmcroft commented Jun 18, 2022

Merged your changes for this into the #171 PR 😄

@mindsolve
Copy link
Author

Very nice, thank you @jamesmcroft! Do you think that the two open points (comment above) should also be added in that change? Or do we leave it like this, as it covers the most common uses and possibly add them later?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants