Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Restored docstring paragraph formatting #199

Merged
merged 2 commits into from
Feb 10, 2022
Merged

Restored docstring paragraph formatting #199

merged 2 commits into from
Feb 10, 2022

Conversation

DataGhost
Copy link
Contributor

Fixes #198

DataGhost added 2 commits February 9, 2022 18:43
Splits docstring into paragraphs before replacing newlines by spaces,…
5411cfa 
… then rejoins them. This preserves the formatting as used in the code.

Removed the superfluous call to strip() which made it impossible to use code blocks.
Brought back strip() in the form of rstrip() since cleandoc() only cl…
44ac3a0 
…eans the left side

Added two tests for the new behaviour
@DataGhost
Copy link
Contributor Author

I forgot to run the tests and add some new ones. Unsure how extensive these tests need to be but I think this caught the most obvious cases. Since cleandoc() only cleans the left side of strings, I changed the original strip() call to just rstrip(), that should do the trick and also leaves the original test results as they were.

@kemingy kemingy merged commit 301e157 into 0b01001001:master Feb 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kemingy kemingy kemingy approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[BUG] Paragraph formatting is removed from openapi.json
2 participants
@DataGhost @kemingy