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

feat: render deprecated setting as strikethrough #252

Merged
merged 1 commit into from
Aug 8, 2024

Conversation

ndr-brt
Copy link
Member

@ndr-brt ndr-brt commented Aug 8, 2024

What this PR changes/adds

Render @Deprecated setting as strikethrough in autodoc output

Why it does that

documentation

Further notes

List other areas of code that have changed but are not necessarily linked to the main feature. This could be method
signature changes, package declarations, bugs that were encountered and were fixed inline, etc.

Linked Issue(s)

Closes #251

Please be sure to take a look at the contributing guidelines and our etiquette for pull requests.

@ndr-brt ndr-brt added the documentation Improvements or additions to documentation label Aug 8, 2024
Copy link

github-actions bot commented Aug 8, 2024

Test Results

52 tests  +3   52 ✅ +3   19s ⏱️ -1s
21 suites +1    0 💤 ±0 
21 files   +1    0 ❌ ±0 

Results for commit 0bec7df. ± Comparison against base commit 388ab13.

♻️ This comment has been updated with latest results.

@ndr-brt ndr-brt force-pushed the 251-mark-deprecated branch from f3d9d23 to 1696e0a Compare August 8, 2024 07:26
@ndr-brt ndr-brt force-pushed the 251-mark-deprecated branch from 1696e0a to 0bec7df Compare August 8, 2024 07:28
@ndr-brt ndr-brt merged commit 07648d1 into main Aug 8, 2024
17 checks passed
@ndr-brt ndr-brt deleted the 251-mark-deprecated branch August 8, 2024 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Mark @Deprecated settings as deprecated in autodoc
2 participants