Documentation on docstrings #3773
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
MikaelMayer
requested changes
Mar 21, 2023
docs/DafnyRef/Grammar.md
Outdated
| by IDEs and documentation generation tools to present information to users. | ||
|
|
||
| In Dafny programs. | ||
| * Documentation comments are recommended to begin with `/**`, though some |
There was a problem hiding this comment.
Actually, documentation must start with "/**" if it placed before, but we don't have such recommendation for docstrings placed after signature. It's even easier to write just "//" like for variable declarations. So I would rephrase it accordingly.
docs/DafnyRef/Grammar.md
Outdated
Comment on lines
191
to
192
| * If doc-comments are in both places the content is concatenated. | ||
| * Doc-comments after the declaration are preferred. |
There was a problem hiding this comment.
Suggested change
| * If doc-comments are in both places the content is concatenated. | |
| * Doc-comments after the declaration are preferred. | |
| * If doc-comments are in both places the content is concatenated. | |
| * Doc-comments after the declaration are preferred. |
If doc comments are in both places, only the one below/after is considered.
Single-line comments are concatenated only if they are on the same side of the docstring
Co-authored-by: Mikaël Mayer <MikaelMayer@users.noreply.github.com>
… into cok-3771-docstrings
MikaelMayer
approved these changes
Apr 6, 2023
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.
Accompanies PR 3756. Fixes #3771.
By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.