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

Enforce single line description #183

Closed
edgarrmondragon opened this issue Apr 17, 2024 · 3 comments · Fixed by #184
Closed

Enforce single line description #183

edgarrmondragon opened this issue Apr 17, 2024 · 3 comments · Fixed by #184

Comments

@edgarrmondragon
Copy link
Contributor

And maybe make it opt-in. This tool already strips whitespace from the field:

if "description" in project:
project["description"] = String.from_raw(str(project["description"]).strip())

Related:

@gaborbernat
Copy link
Member

I would be okay to accept a pull request in this direction.

@henryiii
Copy link
Contributor

henryiii commented Apr 17, 2024

Would it make sense to turn this:

description = """A Machine learning library that models and predicts learner engagement
                 with educational resources."""

Into this:

description = "A Machine learning library that models and predicts learner engagement with educational resources."

Or this:

description = """A Machine learning library that models and predicts learner engagement\
 with educational resources."""

? Both are fine IMO, though I prefer the first, as this isn't supposed to be a really long line (it's displayed on PyPI, etc).

More fun ones are ones like https://github.com/Abdel-RahmanSaied/mediaSecure/blob/caabcf86622a519a55a99f604d8dad60a27f94bc/pyproject.toml#L11-L47 :)

@edgarrmondragon
Copy link
Contributor Author

I've started #184 with the first option above as the goal.

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 a pull request may close this issue.

3 participants