Added prefix argument to keywords tool #492
Open
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 changed previous prefix argument to write-prefixes, as that is what it did
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #492 +/- ##
==========================================
- Coverage 84.84% 84.72% -0.13%
==========================================
Files 30 30
Lines 4784 4792 +8
==========================================
+ Hits 4059 4060 +1
- Misses 725 732 +7 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
jesper-friis
requested changes
Jan 13, 2026
Contributor
jesper-friis
left a comment
jesper-friis
left a comment
There was a problem hiding this comment.
Suggested some changes. Nice implementation of the --prefix argument
| ) | ||
| if is_curie(name): | ||
| return name | ||
| print(name) |
Comment on lines
+1639
to
+1640
| namespace_filter: Keep only keywords within this namespace. | ||
| A prefix, namespace or a sequence of these. |
Contributor
There was a problem hiding this comment.
Suggested change
| namespace_filter: Keep only keywords within this namespace. | |
| A prefix, namespace or a sequence of these. | |
| namespace_filter: A prefix, namespace or a sequence of these. | |
| Keep only keywords within this namespace. |
| "the namespace " | ||
| "provided by this option. Can be provided more that once. " | ||
| "To be used with the --keywords option. " | ||
| "To be used with the --write-markdown option. " |
Contributor
There was a problem hiding this comment.
Suggested change
| "To be used with the --write-markdown option. " | |
| "To be used with the --write-kw-md option. " |
Comment on lines
+1924
to
+1925
| "If missing," | ||
| "it can be added with --prefix." |
Contributor
There was a problem hiding this comment.
Suggested change
| "If missing," | |
| "it can be added with --prefix." | |
| "If missing, t can be added with --prefix." |
| help=( | ||
| "Comma-separated list of keywords to include in generated table. " | ||
| "Implies --keywords." | ||
| "Implies --write-markdown." |
Contributor
There was a problem hiding this comment.
Suggested change
| "Implies --write-markdown." | |
| "Implies --write-kw-md." |
| "Generate keywords Markdown documentation for any keywords who's " | ||
| "domain is in the comma-separated list CLASSES. " | ||
| "Implies --keywords." | ||
| "Implies --write-markdown." |
Contributor
There was a problem hiding this comment.
Suggested change
| "Implies --write-markdown." | |
| "Implies --write-kw-md." |
| "--prefixes", | ||
| "-p", | ||
| "--write-prefixes", | ||
| "-w", |
Contributor
There was a problem hiding this comment.
Not a very intuitive short option name, but -p is already used. We can either keep it as it is or remove the short option.
| "-w", | ||
| metavar="FILENAME", | ||
| help="Generate prefixes Markdown documentation.", | ||
| help="Write prefixes file.", |
Contributor
There was a problem hiding this comment.
Suggested change
| help="Write prefixes file.", | |
| help="Write prefixes Markdown file.", |
|
|
||
| kw = Keywords(theme=default_theme) | ||
|
|
||
| if args.prefix: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Also changed previous prefix argument to write-prefixes, as that is what it did
Description
Type of change
Checklist for the reviewer
This checklist should be used as a help for the reviewer.