Docs: Edit 'file-system' module #1510
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
- Add graphviz extension to create a class hierarchy to file system, posix and microsoft locators. - Remove reference to 'file-stream' module. This paragraph was moved from module 'locators' and contained a reference to the module 'file-system', not needed now. - Rename key parameter 'filename'. The key parameter appears as 'filename' and in the documentation of the method as 'locator'. - To eliminate document duplication, I decided to address the issue in the paragraph discussing the 'make' method. Since it bears close resemblance to the method reference, I opted to remove the initial paragraph and provide a link to the reference instead. Additionally, I consolidated the documentation for the key parameters 'direction' and 'buffer-size' with a more comprehensive explanation.
cgay
approved these changes
Jun 29, 2023
| @@ -885,19 +952,22 @@ File-System module. | |||
| instantiated, this method calls the generic function | |||
| :gf:`type-for-file-stream`. | |||
|
|
|||
| The *filename* init-keyword should be a string naming a file. If | |||
| The *locator* init-keyword should be a string naming a file. If | |||
| the :doc:`Locators <../system/locators>` library is in use, | |||
There was a problem hiding this comment.
pre-existing: "library" here should be "module"
There was a problem hiding this comment.
Actually I don't think we need to conditionalize this at all. Why not just say "The locator argument should be a :class:`<file-locator>` or a :drm:`<string>` that can be coerced to one.
cgay
approved these changes
Jun 29, 2023
cgay
pushed a commit
to cgay/opendylan
that referenced
this pull request
Apr 8, 2024
- Add graphviz extension to create a class hierarchy to file system, posix and microsoft locators. - Remove reference to 'file-stream' module. This paragraph was moved from module 'locators' and contained a reference to the module 'file-system', not needed now. - Rename key parameter 'filename'. The key parameter appears as 'filename' and in the documentation of the method as 'locator'. - To eliminate document duplication, I decided to address the issue in the paragraph discussing the 'make' method. Since it bears close resemblance to the method reference, I opted to remove the initial paragraph and provide a link to the reference instead. Additionally, I consolidated the documentation for the key parameters 'direction' and 'buffer-size' with a more comprehensive explanation.
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.
Add graphviz extension to create a class hierarchy to file system, posix and microsoft locators.
Remove reference to 'file-stream' module. This paragraph was moved from module 'locators' and contained a reference to the module 'file-system', not needed now.
Rename key parameter 'filename'. The key parameter appears as 'filename' and in the documentation of the method as 'locator'.
To eliminate document duplication, I decided to address the issue in the paragraph discussing the 'make' method. Since it bears close resemblance to the method reference, I opted to remove the initial paragraph and provide a link to the reference instead. Additionally, I consolidated the documentation for the key parameters 'direction' and 'buffer-size' with a more comprehensive explanation.