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

Support multiline docs #133

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Support multiline docs #133

wants to merge 1 commit into from

Conversation

Timmmm
Copy link

@Timmmm Timmmm commented Jul 15, 2022

Adds basic support for multiline docstrings. The rule is basically if a line starts with an alphabetic character then it is joined to the previous line.

Fixes #121
Fixes #128

sadmac7000
sadmac7000 requested changes Nov 10, 2022
View reviewed changes
argh_derive/src/parse_attrs.rs Outdated Show resolved Hide resolved
argh_derive/src/parse_attrs.rs Outdated Show resolved Hide resolved
@sadmac7000
Copy link
Collaborator

This could land if rebased and reformatted.

@Timmmm
Copy link
Author

Timmmm commented Nov 16, 2023

I have rebased, formatted and squashed it. Unfortunately there are two issues I found:

  1. The escaped_doc_comment_description test fails due to an extra newline.
  2. You can't start a description with a capital letter which seems overly restrictive and weird for a multi-line paragraph.

I have stopped using argh and switch to Clap, so I'll leave you to decide how to deal with this (fix those issues or just close this).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sadmac7000 sadmac7000 sadmac7000 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.

Process line breaks in description Help comment is unexpectedly mangled
2 participants
@Timmmm @sadmac7000