doc(Style): clarify indentation of documentation strings #596
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
templates/contribute/style.md
Outdated
| @@ -80,7 +80,8 @@ two main concepts in the theory of xyzzyology. | |||
| ## Main results | |||
|
|
|||
| - `exists_foo`: the main existence theorem of `foo`s. | |||
| - `bar_of_foo`: a construction of a `bar`, given a `foo`. | |||
| - `bar_of_foo`: a construction of a `bar`, given a `foo` under very complicated | |||
| and intricate circumstances worth describing in excruciating detail. | |||
There was a problem hiding this comment.
I don’t understand what this change is doing here.
There was a problem hiding this comment.
The change is meant to illustrate an example, where an item spans multiple lines. (I got this wrong previously, by not indenting the second line: this is not how markdown expects items. Hence, I think this is worth clarifying.)
It seems the wording is not clear; I'm very happy to change it. For instance, would this be clearer?
- `bar_of_foo_of_baz`: a construction of a `bar`, given a `foo` and a `baz`. If this doc-string was longer than one
line, subsequent lines should be indented by two spaces (as required by markdown syntax).
There was a problem hiding this comment.
I have updated the phrasing. @PatrickMassot Does that address your comment?
grunweg
commented
Apr 8, 2025
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.
I searched for guidelines here, and could not find them. Zulip yields very clear rules; let's codify them.