Skip to content

docs: show deprecation warnings in api docs #524

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

Merged
merged 1 commit into from
Feb 20, 2022

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Feb 20, 2022

Fixes #516

This PR adds a deprecation warning and See Also links.

Example

grafic

@ST-DDT ST-DDT added the c: docs Improvements or additions to documentation label Feb 20, 2022
@ST-DDT ST-DDT self-assigned this Feb 20, 2022
@ST-DDT
Copy link
Member Author

ST-DDT commented Feb 20, 2022

Blocked: Merge to main after #446 has been merged.

@ST-DDT ST-DDT linked an issue Feb 20, 2022 that may be closed by this pull request
@ST-DDT ST-DDT added do NOT merge yet Do not merge this PR into the target branch yet s: on hold Blocked by something or frozen to avoid conflicts labels Feb 20, 2022
@ST-DDT ST-DDT changed the title docs: use vue components for api-docs docs: show deprecation warnings in api docs Feb 20, 2022
@codecov
Copy link

codecov bot commented Feb 20, 2022

Codecov Report

Merging #524 (4181041) into main (4e066e8) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #524   +/-   ##
=======================================
  Coverage   99.34%   99.34%           
=======================================
  Files        1919     1919           
  Lines      176315   176315           
  Branches      904      904           
=======================================
  Hits       175158   175158           
  Misses       1101     1101           
  Partials       56       56           

@ST-DDT ST-DDT force-pushed the docs/show-deprecation-warning branch from 953e95f to 31db0fe Compare February 20, 2022 17:17
@Shinigami92 Shinigami92 force-pushed the docs/api-docs-components branch from ad995ac to 6d6eb5a Compare February 20, 2022 17:41
@ST-DDT ST-DDT force-pushed the docs/api-docs-components branch from 6d6eb5a to 2d43249 Compare February 20, 2022 18:07
@ST-DDT ST-DDT force-pushed the docs/show-deprecation-warning branch from 31db0fe to a4eac74 Compare February 20, 2022 18:17
Base automatically changed from docs/api-docs-components to main February 20, 2022 18:28
@ST-DDT ST-DDT force-pushed the docs/show-deprecation-warning branch from a4eac74 to 4181041 Compare February 20, 2022 18:30
@ST-DDT ST-DDT marked this pull request as ready for review February 20, 2022 18:30
@ST-DDT ST-DDT requested a review from a team as a code owner February 20, 2022 18:30
@ST-DDT ST-DDT removed do NOT merge yet Do not merge this PR into the target branch yet s: on hold Blocked by something or frozen to avoid conflicts labels Feb 20, 2022
@ST-DDT ST-DDT requested a review from a team February 20, 2022 18:35
@ST-DDT ST-DDT merged commit 1058e17 into main Feb 20, 2022
@ST-DDT ST-DDT deleted the docs/show-deprecation-warning branch February 20, 2022 18:52
demipel8 pushed a commit to demipel8/faker that referenced this pull request Mar 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Show deprecation warning on the api docs page
3 participants