Fix markdown glitches in generated classifiers documentation #204
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Glitches were caused by table-of-contents logic which in absence of title was trying to take x first characters of description, resulting in eg. yaml snippets cut in half. This commits avoid glitches by **not** using dot on first sentence, so that go-swagger knows that the first sentence is a title.
kwapik
approved these changes
Aug 26, 2022
There was a problem hiding this comment.
Reviewed 9 of 9 files at r1, all commit messages.
Reviewable status:complete! all files reviewed, all discussions resolved (waiting on @krdln)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Glitches were caused by table-of-contents logic which in absence of
title was trying to take x first characters of description, resulting in
eg. yaml snippets cut in half.
This commits avoid glitches by not using dot on first sentence, so
that go-swagger knows that the first sentence is a title.
Resolves: #202
This change is