tox-dev / pyproject-fmt

MIT License
167 stars 27 forks source link

Enforce single line `description` #183

Closed edgarrmondragon closed 5 months ago

edgarrmondragon commented 5 months ago

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

https://github.com/tox-dev/pyproject-fmt/blob/bb6005786f6624d72a66b7be876696a788ce7414/src/pyproject_fmt/formatter/project.py#L41-L42

Related:

gaborbernat commented 5 months ago

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

henryiii commented 5 months ago

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 commented 5 months ago

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