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

Short help with summary line #1695

Merged
merged 1 commit into from Oct 30, 2020
Merged

Short help with summary line #1695

merged 1 commit into from Oct 30, 2020

Conversation

srafi1
Copy link
Contributor

@srafi1 srafi1 commented Oct 22, 2020 •
edited

Automatically generated short help messages will stop at the first double linebreak which indicates a summary line. Sometimes the summary line does not have a period, so short help messages end up malformed.

Checklist:

  • Add tests that demonstrate the correct behavior of the change. Tests should fail without the change.
  • Add or update relevant docs, in the docs folder and in code.
  • Add an entry in CHANGES.rst summarizing the change and linking to the issue.
  • Add .. versionchanged:: entries in any relevant code docs.
  • Run pre-commit hooks and fix any issues.
  • Run pytest and tox, no tests failed.

@srafi1 srafi1 marked this pull request as draft October 22, 2020 23:52
@srafi1 srafi1 changed the title <!-- Before opening a PR, open a ticket describing the issue or feature the PR will address. Follow the steps in CONTRIBUTING.rst. Replace this comment with a description of the change. Describe how it addresses the linked ticket. --> Summary line with line break Oct 22, 2020
@srafi1 srafi1 changed the title Summary line with line break Short help with summary line Oct 22, 2020
@srafi1 srafi1 marked this pull request as ready for review October 23, 2020 00:05
@amy-lei amy-lei added this to the 8.0.0 milestone Oct 30, 2020
@amy-lei amy-lei merged commit a4763ef into pallets:master Oct 30, 2020
@srafi1 srafi1 deleted the help-summary branch October 30, 2020 20:56
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 14, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
8.0.0
Development

Successfully merging this pull request may close these issues.

Automatic short help should also take linebreak into account
2 participants
@srafi1 @amy-lei