Refactor the docs to promote user functions#239
Merged
offbyone merged 3 commits intohamcrest:mainfrom Aug 30, 2023
Merged
Conversation
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.
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 |
Member
|
Thanks! It'll update the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.