[docs] misc. docs cleanup #72
Merged
Conversation
This file contains 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
jameslamb
commented
Oct 24, 2022
| # included test files | ||
| # found executable files | ||
| # wheel contains compiled objects/libraries with debug symbols | ||
| # found files with spaces in their names |
jameslamb
commented
Oct 24, 2022
| # found executable files | ||
| # wheel contains compiled objects/libraries with debug symbols | ||
| # found files with spaces in their names | ||
| # found file paths longer than {} characters |
jameslamb
commented
Oct 24, 2022
| # wheel contains compiled objects/libraries with debug symbols | ||
| # found files with spaces in their names | ||
| # found file paths longer than {} characters | ||
| # found files with names containing control characters |
There was a problem hiding this comment.
- special characters: [new check] special characters in filepaths #77
- non-ASCII characters: [new check] filepaths with non-ASCII characters #76
- paths differ only by case: [new check] paths that differ only by case #75
jameslamb
commented
Oct 24, 2022
| @@ -115,16 +115,6 @@ def check( | |||
| print(f"errors found while checking: {len(errors)}") | |||
| sys.exit(len(errors)) | |||
|
|
|||
| # surprising / disallowed file extensions | |||
jameslamb
commented
Oct 24, 2022
| # surprising / disallowed file extensions | ||
| # included test files | ||
| # found executable files | ||
| # wheel contains compiled objects/libraries with debug symbols |
jameslamb
commented
Oct 24, 2022
| # found files with spaces in their names | ||
| # found file paths longer than {} characters | ||
| # found files with names containing control characters | ||
| # more than {n} total files |
There was a problem hiding this comment.
this was implemented already, in #27
jameslamb
commented
Oct 24, 2022
| @@ -115,16 +115,6 @@ def check( | |||
| print(f"errors found while checking: {len(errors)}") | |||
| sys.exit(len(errors)) | |||
|
|
|||
| # surprising / disallowed file extensions | |||
| # included test files | |||
| # found executable files | |||
jameslamb
commented
Oct 24, 2022
| @@ -115,16 +115,6 @@ def check( | |||
| print(f"errors found while checking: {len(errors)}") | |||
| sys.exit(len(errors)) | |||
|
|
|||
| # surprising / disallowed file extensions | |||
| # included test files | |||
There was a problem hiding this comment.
This one is controversial. For example, as one audience member in my SciPy 2022 talk mentioned, it's sometimes necessary to include tests in a distribution so that re-packagers like conda are able to run those tests on the new distributions they create.
So for now, I'm going to let this idea die in comments.
jameslamb
commented
Oct 24, 2022
|
|
||
| ```shell | ||
| make build install | ||
|
|
||
| pydistcheck-summarize \ |
There was a problem hiding this comment.
summarize needs work. #79
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.
Contributes to #46.
Starts some cleanup of the documentation, and moving more ideas for future development out of code comments and into the issue tracker.