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

Only use the first line of the docstring #10

Open
MartinThoma opened this issue Apr 7, 2023 · 0 comments
Open

Only use the first line of the docstring #10

MartinThoma opened this issue Apr 7, 2023 · 0 comments

Comments

@MartinThoma
Copy link

MartinThoma commented Apr 7, 2023

I sometimes have pretty long docstrings explaining what the test does / why it was added. For the output, I would only want the first line of such long docstrings to be used (the "summary line").

Please note that the first line might be empty ... so technically the second line. The first line which has more than just whitespace.

(PS: Awesome plugin!)

How it looks like at the moment

For pypdf, executed as pytest tests/test_xmp.py --pspec:

image

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

No branches or pull requests

1 participant