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.

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

Docs processing - don't break markdown input #184

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

mpajkowski
Copy link

This PR makes Markdown parsers happier by disabling line merging.

@ralpha
Copy link
Contributor

ralpha commented Oct 17, 2022

Note: There has already been some discussion about this some time ago.
See #120
So make sure this PR works for everyone.

@mpajkowski
Copy link
Author

It's a breaking change for users relying on current behaviour, indeed.

I think I can add flag to SchemaSettings which enables/disables stripping exceeding lines (on by default).
I considered custom de-stripping Visitor for a moment, but I think it will be easier to keep it raw at this stage.

@mpajkowski
Copy link
Author

I reworked my solution.

I created SchemaSettings::raw_description_text flag which toggles described behaviour (set to false by default). Actually this flag is honoured on the derive side - This way we only touch doc comments generated by JsonSchema macro.

I also updated tests and docs.

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