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

Refactor the docs to promote user functions #239

Merged

Conversation

robyoung
Copy link
Contributor

The functions that users most often use are the matcher functions, however the docs show the internal matcher classes first. This means that users have to scan through a bunch of internal detail to get to the documentation they're most likely interested in. This change switches things around to just document the actual matcher functions.

The functions that users most often use are the matcher functions,
however the docs show the internal matcher classes first. This means
that users have to scan through a bunch of internal detail to get to the
documentation they're most likely interested in. This change switches
things around to just document the actual matcher functions.
@offbyone
Copy link
Member

I like the idea, but I don't like that this version of the docs has dropped documentation on the classes entirely.

How about maybe a second section called "Matcher Internals" that does the same thing, roughly, but for the implementing classes, or -- and I know this'd be duplicative a bit -- uses automodule to make sure it shows all the internals. Then, the "Matcher Library" section will become a tighter bit of documentation for the library the way you've done here, but we'll still see all the gory details elsewhere. Ideally the matcher library will link to the relevant section of the matcher internals pages.

@offbyone offbyone merged commit 8f160f8 into hamcrest:main Aug 30, 2023
31 checks passed
@offbyone
Copy link
Member

Thanks! It'll update the latest pyhamcrest docs, and when we next do a release this'll become the stable format for the docs too.

@robyoung robyoung deleted the refactor-docs-to-promote-user-functions branch August 31, 2023 08:00
This pull request was closed.
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

Successfully merging this pull request may close these issues.

2 participants