Remove collections convenience module, doc updates #1667
Merged
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
This module only exported _some_ of the other modules in the collections library, just creating a potential for confusion. Instead we should decide whether to export one module or many. The easy choice is to remove the convenience module, which was a late addition.
housel
approved these changes
Mar 7, 2025
|
|
||
| - :type:`<byte>` | ||
|
|
||
| .. <byte> is defined in the dylan library but documented here (for reasons?). |
There was a problem hiding this comment.
It's defined in the dylan library because it's referenced by language extensions and implementation details that have to be there. It's not documented with the dylan library because it's not defined in the DRM.
There was a problem hiding this comment.
Right, I was a bit lazy with that comment and I'll remove it.
I was basically wondering why we don't document it in dylan-extensions directly instead of somewhere that it is re-exported from.
Various minor corrections and additions to the docs, plus remove some of the methods from the table of contents if they have no additional documentation other than their specializer types. This follows the recent change to sphinx-extensions that added all Dylan definitions to the ToC.
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.
No description provided.