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 Validation Script to Not Error Out if Bullet Points Don't End with Period #25461

Open
WillAyd opened this issue Feb 27, 2019 · 1 comment
Labels
CI Continuous Integration Docs

Comments

@WillAyd
Copy link
Member

WillAyd commented Feb 27, 2019

Quite a few PRs lately have worked around the validation script error of descriptions not ending with a period when there are bullet points by adding periods to the end of each bullet point. This looks tacky and is really just a hack to get around the validator failing.

Would rather update the validator to maybe ignore bullet points as part of the description, though @datapythonista may have other thoughts.

xref #20298

@WillAyd WillAyd added Docs CI Continuous Integration labels Feb 27, 2019
@WillAyd WillAyd added this to the Contributions Welcome milestone Feb 27, 2019
@gwrome
Copy link
Contributor

gwrome commented Mar 19, 2019

This could be as simple as removing two lines from the validator:

if doc.parameter_desc(param)[-1] != '.':
  errs.append(error('PR09', param_name=param))

This solution is effectively the same as removing error code PR09.

Is this the outcome you're looking for? Or are there cases in which you want the validator to complain about bullets not ending in periods?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration Docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants