Skip to content

Docs: improve/cleanup reference from/to recwarn #12866

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.

Sign up for GitHub

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

Jump to bottom
Merged
nicoddemus merged 3 commits into from
Oct 10, 2024
Merged

Docs: improve/cleanup reference from/to recwarn #12866

nicoddemus merged 3 commits into from
Oct 10, 2024
+13 −14

Conversation

@soxofaan
Copy link
Contributor

@soxofaan soxofaan commented Oct 9, 2024 •
edited
Loading

  • Allow maintainers to push and squash when merging my commits. Please uncheck this if you prefer to squash the commits yourself.
  • Create a new changelog file in the changelog folder, with a name like <ISSUE NUMBER>.<TYPE>.rst. See changelog/README.rst for details.
  • Add yourself to AUTHORS in alphabetical order.

soxofaan added a commit to soxofaan/pytest that referenced this pull request Oct 9, 2024
@soxofaan
PR pytest-dev#12866 add changelog item
26470eb
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided (automation) changelog entry is part of PR label Oct 9, 2024
soxofaan added a commit to soxofaan/pytest that referenced this pull request Oct 9, 2024
@soxofaan
PR pytest-dev#12866 add changelog item
1edd026
@soxofaan
Copy link
Contributor Author

soxofaan commented Oct 9, 2024

I was looking up some docs around the recwarn fixture today and had a hard time getting to the point. This PR tries to fix some problems in the docs around that:

  • replace some raw http links with sphinx references
  • when mentioning recwarn, point to the API docs instead of a section that barely explains something about recwarn
  • from the recwarn API docs, provide cross-reference to a how-to section about recwarn instead of something loosely related
  • recwarn API docs: also document __getitem__, __iter__ and __len__ (which are shown in the how to, but not explained)

@soxofaan soxofaan marked this pull request as ready for review October 9, 2024 20:40
nicoddemus
nicoddemus requested changes Oct 9, 2024
View reviewed changes
@soxofaan soxofaan requested a review from nicoddemus October 10, 2024 07:21
nicoddemus
nicoddemus approved these changes Oct 10, 2024
View reviewed changes
Copy link
Member

@nicoddemus nicoddemus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@nicoddemus nicoddemus merged commit 26a29bd into pytest-dev:main Oct 10, 2024
@patchback
Copy link

patchback bot commented Oct 10, 2024 •
edited
Loading

Backport to 8.3.x: 💚 backport PR created

✅ Backport PR branch: patchback/backports/8.3.x/26a29bdade7efccdf6233942749f02cef57ce694/pr-12866

Backported as #12870

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Oct 10, 2024
@soxofaan @nicoddemus @patchback
Docs: improve/cleanup reference from/to recwarn (#12866)
2014534 
Co-authored-by: Bruno Oliveira <bruno@soliv.dev>
(cherry picked from commit 26a29bd)
@patchback patchback bot mentioned this pull request Oct 10, 2024
Merged
3 tasks
nicoddemus pushed a commit that referenced this pull request Oct 10, 2024
@patchback @soxofaan
Docs: improve/cleanup reference from/to recwarn (#12866) (#12870)
09da0de 
Co-authored-by: Bruno Oliveira <bruno@soliv.dev>
(cherry picked from commit 26a29bd)

Co-authored-by: Stefaan Lippens <soxofaan@users.noreply.github.com>
@soxofaan soxofaan deleted the recwarn-docs branch October 10, 2024 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nicoddemus nicoddemus nicoddemus approved these changes

Assignees

No one assigned

Labels

bot:chronographer:provided (automation) changelog entry is part of PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@soxofaan @nicoddemus