Skip to content

fix: summary with back ticks and sphinx field names with periods#248

Merged
weibullguy merged 4 commits intomasterfrom
fix/issue_243
Jul 5, 2023
Merged

fix: summary with back ticks and sphinx field names with periods#248
weibullguy merged 4 commits intomasterfrom
fix/issue_243

Conversation

@weibullguy
Copy link
Member

Fixes not formatting docstrings with a summary containing back ticks and Sphinx-style field names containing periods.

Closes #243
Closes #245

@weibullguy weibullguy added P: bug PEP 257 violation or existing functionality that doesn't work as documented C: style Relates to docstring format style (e.g., Google, NumPy, Sphinx) labels Jul 5, 2023
@weibullguy weibullguy merged commit 3eb6241 into master Jul 5, 2023
@weibullguy weibullguy deleted the fix/issue_243 branch July 5, 2023 22:30
@weibullguy weibullguy added the S: merged Closed with work merged to repository label Jul 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C: style Relates to docstring format style (e.g., Google, NumPy, Sphinx) P: bug PEP 257 violation or existing functionality that doesn't work as documented S: merged Closed with work merged to repository

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sphinx style field lists with . characters in the names are formatted incorrectly Docstrings containing backticks are not formatted

1 participant