Skip to content

Documented how to represent Python and RFC objects with either Sphinx… - #2147

Merged
stevepiercy merged 5 commits into
mainfrom
2069-docs-inline-literals
Nov 19, 2026
Merged

stevepiercy merged 5 commits into
mainfrom
2069-docs-inline-literals

Conversation

@stevepiercy

Copy link
Copy Markdown
Member

… cross-references, inline literals, or ordinary text

Linked issue

Description

  • Documented and changed GitHub user syntax for change log entries
  • Use 4-space indentation
  • Replace MyST syntax with reStructuredText syntax for Test docstring structure
  • Mention Style guide in Contribute guide

… cross-references, inline literals, or ordinary text

- Added GitHub `user` syntax for change log entries
- Use 4-space indentation
- Replace MyST syntax with reStructuredText syntax for Test docstring structure
- Mention Style guide in Contribute guide
@github-actions

Copy link
Copy Markdown
Contributor

Thanks for the pull request, @stevepiercy! A maintainer will review it shortly.

@niccokunzmann niccokunzmann left a comment

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.

Hi, I have some suggestions, mostly out-of-scope ones. Thanks for the PR.

Comment thread docs/contribute/index.rst Resolved
@stevepiercy
stevepiercy enabled auto-merge (squash) November 19, 2026 11:08
@stevepiercy
stevepiercy disabled auto-merge November 19, 2026 11:15
@stevepiercy
stevepiercy merged commit d95d9b5 into main Nov 19, 2026
27 checks passed
@stevepiercy
stevepiercy deleted the 2069-docs-inline-literals branch November 19, 2026 11:15
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.

Distinguish use of inline literals for RFC and Python contexts

2 participants