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

Fix docs lint warning #282

Merged

Conversation

ashokdelphia
Copy link
Contributor

Fix pyroma lint warning.

It's complaining about the underline being shorter than the heading:

Before:

$ pyroma .
------------------------------
Checking .
Found pytest-postgresql
------------------------------
Your long_description is not valid ReST: 
<string>:239: (WARNING/2) Title underline too short.

unreleased
-------
------------------------------
Final rating: 9/10
Cottage Cheese
------------------------------

After:

$ pyroma .
------------------------------
Checking .
Found pytest-postgresql
------------------------------
Final rating: 10/10
Your cheese is so fresh most people think it's a cream: Mascarpone
------------------------------

(This seemed too trivial to warrant an issue; please advise if you would like one for completeness.)

It's complaining about the underline being shorter than the heading.
@coveralls
Copy link

Coverage Status

Coverage remained the same at 57.182% when pulling 9018653 on ashokdelphia:fix-pyroma-lint-warning-in-changes into ec4b46b on ClearcodeHQ:master.

1 similar comment
@coveralls
Copy link

Coverage Status

Coverage remained the same at 57.182% when pulling 9018653 on ashokdelphia:fix-pyroma-lint-warning-in-changes into ec4b46b on ClearcodeHQ:master.

@coveralls
Copy link

coveralls commented Feb 12, 2020

Coverage Status

Coverage increased (+0.6%) to 57.766% when pulling b89f024 on ashokdelphia:fix-pyroma-lint-warning-in-changes into ec4b46b on ClearcodeHQ:master.

@fizyk
Copy link
Member

fizyk commented Feb 13, 2020

Also update .bumpversion.cfg there's an underline that ought to be compatible with this

@fizyk
Copy link
Member

fizyk commented Feb 13, 2020

Anyway for this underline and due to the bumpversion it's most important if it renders correctly rather than if it has same length

Copy link
Member

@fizyk fizyk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update bumpversion.cfg as well

@ashokdelphia
Copy link
Contributor Author

Ouch. Sorry to not see how the bump works. Thanks for pointing that out.

In terms of rendering, a longer line under a version number should still render the same way. I'm somewhat inclined to change all of the version title-lines to be the same length, so they are definitely consistent.

@fizyk fizyk merged commit 10e385e into ClearcodeHQ:master Feb 14, 2020
@ashokdelphia ashokdelphia deleted the fix-pyroma-lint-warning-in-changes branch February 14, 2020 18:43
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.

None yet

3 participants