Add documentation_style to with short and full options #716
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
|
@emilio sorry to spring a PR without an issue first... what do you think of the feature? |
|
Anything I can do to help with the load at all? |
|
Sorry, it's been pretty weird times for me lately so haven't been able to do much non-work stuff, looking now |
emilio
approved these changes
Nov 2, 2021
| @@ -76,7 +76,12 @@ impl Source for Documentation { | |||
| _ => (), | |||
| } | |||
|
|
|||
| for line in &self.doc_comment { | |||
| let end = match config.documentation_length { | |||
There was a problem hiding this comment.
Can we handle it also in the cython case just for completeness? Should be trivial moving this a few lines above but if you don't have the time I'm happy to do it.
|
I can fix cython for you before publishing, thanks, and sorry again for the massive lag. |
|
a1694cd fixes cython |
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.
When the "short" option is used, only the first line of the docs is output for each item.
The motivation for this change is to encourage writing longer docs with examples, while still keeping the header file more concise. The header file top can include a link to the full published docs instead.