Add --ignore CLI option and ignore_files config field
#60
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
lagru
added
documentation
because it isn't available in earlier versions.
Windows uses different path separators of course, so there is no easy way to get this doctest working on both platforms. Instead let's just skip this...
lagru
commented
Jun 6, 2025
Comment on lines
+8
to
+10
| Files: src/docstub/_vendored/stdlib.py | ||
| Copyright: 2001-2025, Python Software Foundation | ||
| License: PSF-2.0 |
There was a problem hiding this comment.
@stefanv could I ask you to take a look if I handled the license situation correctly here? I'd like to vendor Python's glob.translate which is only available from 3.13 onward.
I'm also not sure if need to adapt the SPDX license identifier in the pyproject.toml since the vendored part now uses a different one. 🤔
There was a problem hiding this comment.
I've been starting to use the SPDX identifiers. There is now a new PEP that allows you to use a specifier+file in pyproject.toml.
Your file seems to be formatted roughly correctly according to https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/#stanzas, except for the dashes.
Should be a bit more expressive.
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.
Closes #59
Both CLI option and config field allow ignoring directories or files in the package directory that docstub is invoked on.
Release note