Skip to content

polish value_separator_index docstring (rfc role + Returns section)#1498

Open
alhudz wants to merge 1 commit into
collective:mainfrom
alhudz:value-separator-docstring
Open

polish value_separator_index docstring (rfc role + Returns section)#1498
alhudz wants to merge 1 commit into
collective:mainfrom
alhudz:value-separator-docstring

Conversation

@alhudz

@alhudz alhudz commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

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:

  • use the :rfc: cross-reference role for the RFC 5545 §3.1 reference instead of plain text, matching the rest of the codebase
  • add a Returns section, per the docstring structure style guide

No behaviour change.

Checklist

  • I've added a change log entry to /news, following the instructions in Change log entry format.
  • I've added or updated tests if applicable. (not applicable, docstring only)
  • I've run and ensured all tests pass locally by following Run tests.
  • I've added or edited documentation, both as docstrings to be rendered in the API documentation and narrative documentation, as necessary.

Additional information

I used the #section-3.1 anchor to match the existing :rfc: usages in the repo.

@github-actions

Copy link
Copy Markdown
Contributor

Profile summary:

GitHub user: alhudz
🟡 Some concerns found with user's profile.
🟢 No concerns found with recent PR activity.
🟢 No concerns found with recent issue activity.

For a more detailed report, run `gh-profiler alhudz`.
Full profile
GitHub user: alhudz
🟡 Some concerns found with user's profile.
   🟢 Account age: 7 years
   🟡 Profile information:
        name: alhuda
        bio: Software Engineer | Building things with code.
      Empty fields: company, blog, location, email

🟢 No concerns found with recent PR activity.
   100 PRs opened in the last 21 days.
      0 opened against repos the user owns.
      0 opened against repos in publicly associated orgs.
      100 opened against external repos.

   🟢 53 of 100 external PRs merged in the last 21 days.
   🟢 7 of 100 external PRs closed without merging in the last 21 days.

🟢 No concerns found with recent issue activity.
   3 new issues opened in the last 21 days.
      0 opened in repos the user owns.
      0 opened in repos in publicly associated orgs.
      3 opened in external repos.

   🟢 0 external issues closed as NOT_PLANNED.
   🟢 0 external issues opened with the same title.

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 icalendar | 🛠️ Build #33265061 | 📁 Comparing e58b7a6 against latest (897bc51)

  🔍 Preview build  

4 files changed
± 404.html
± genindex.html
± reference/api/icalendar.parser.content_line.html
± _modules/icalendar/parser/content_line.html

@@ -0,0 +1 @@
Add an RFC cross-reference and a ``Returns`` section to the ``Contentline.value_separator_index`` docstring.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants