Docs #24
Merged
Docs #24
Conversation
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
Also updated Makefile to remove modules.rst after running sphinx-apidoc. The modules.rst file is usually used in projects with a complex module hierarchy, and is generated automatically with sphinx-apidoc. In this project it is not used, which causes a sphinx warning during the build process. (The warning is harmless, but still.)
This fixes the final Sphinx build warning (due to the file not actually being used anywhere in the docs).
- Expanded docstring of fuzzyfinder function. - Updated type hints to allow for iterables of non-strings.
Collaborator
Author
|
Hi! I have another PR prepared (for the highlight feature) which is based off of these changes, so it would be nice to merge this first to not make a mess out of the commit history. Hope I'm not being too pushy. 😅 |
amjith
approved these changes
Apr 2, 2025
Owner
amjith
left a comment
amjith
left a comment
There was a problem hiding this comment.
Thank you for going through this and updating it. I appreciate it.
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.
Updated
README.mdwith some new usage examples, but mostly updated Sphinx docs.toxusage example to reflect recent(-ish) changes.Resolves #12
NOTE: The docs on readthedocs are not up-to-date. I'd set up a publishing pipeline myself, but I'm not sure I can actually do that (I assume the project is already connected to your RTD account, or something like that). Do you think this is something you could tackle at some point? At the very least it would be nice to update the RTD docs page just to reflect the new changes.