[doc] Fix #1300. Document with-input-to-string and with-output-to-string macros #1554
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
cgay
approved these changes
Feb 8, 2024
| write-element(stream, 'k'); | ||
| end; | ||
|
|
||
| The symmetric macro :macro:`with-input-to-string` creates a |
| :parameter stream-name: A Dylan variable-name *bnf*. | ||
| :parameter string-expression: A Dylan string expression *bnf*. | ||
| :parameter classname: A Dylan class. | ||
| :parameter body: A Dylan body *bnf*. |
There was a problem hiding this comment.
A couple of consistency issues:
- The examples use "name" but the parameter is
stream-name. classnameshould use a hyphen to matchstream-nameand Dylan naming style in general.
| .. macro:: with-output-to-string | ||
| :statement: | ||
|
|
||
| Provides a convenient way of returning a :class:`<string>` after |
There was a problem hiding this comment.
For names that are exported from the dylan module (i.e., defined in the DRM) use :drm: instead of :class:. (There are a few other places where this needs to be fixed.)
| :parameter stream-name: A Dylan variable-name *bnf*. | ||
| :parameter body: A Dylan body *bnf*. | ||
| :value string: Instance of :class:`<string>`. | ||
| : |
Co-authored-by: @cgay
cgay
pushed a commit
to cgay/opendylan
that referenced
this pull request
Apr 8, 2024
…ing macros (dylan-lang#1554) Document macros `with-input-to-string` and `with-output-to-string` Co-authored-by: @cgay
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.
Document macros
with-input-to-stringandwith-output-to-string