polish value_separator_index docstring (rfc role + Returns section)#1498
Open
alhudz wants to merge 1 commit into
Open
polish value_separator_index docstring (rfc role + Returns section)#1498alhudz wants to merge 1 commit into
alhudz wants to merge 1 commit into
Conversation
Contributor
|
Profile summary: Full profile |
stevepiercy
requested changes
Jun 23, 2026
| @@ -0,0 +1 @@ | |||
| Add an RFC cross-reference and a ``Returns`` section to the ``Contentline.value_separator_index`` docstring. | |||
Member
There was a problem hiding this comment.
Don't forget credit!
Suggested change
| Add an RFC cross-reference and a ``Returns`` section to the ``Contentline.value_separator_index`` docstring. | |
| Add an RFC cross-reference and a ``Returns`` section to the ``Contentline.value_separator_index`` docstring. @alhudz |
stevepiercy
reviewed
Jun 23, 2026
Member
There was a problem hiding this comment.
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
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.
Linked issue
No issue to close. Follow-up to @stevepiercy's review on #1472 (the docstring landed just before the review).
Description
Applies the docstring tweaks @stevepiercy asked for on
Contentline.value_separator_index::rfc:cross-reference role for the RFC 5545 §3.1 reference instead of plain text, matching the rest of the codebaseReturnssection, per the docstring structure style guideNo behaviour change.
Checklist
/news, following the instructions in Change log entry format.Additional information
I used the
#section-3.1anchor to match the existing:rfc:usages in the repo.