Skip to content

Developer docs link is confusing #72

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

Closed
jaraco opened this issue Jul 10, 2023 · 1 comment
Closed

Developer docs link is confusing #72

jaraco opened this issue Jul 10, 2023 · 1 comment

Comments

@jaraco
Copy link

jaraco commented Jul 10, 2023

I stumbled on pytest-tap through PyPI and I wanted to get started trying it out. I went to https://pypi.org/project/pytest-tap, but it didn't provide any guidance on how to use it. I'd installed it into my test suite, but nothing happened. I tried passing --tap (following the convention of so many other pytest plugins that required --{name} to be passed to enable the pytest-{name} plugin. So I followed the "Developer documentation" link, but that went to the tappy documentation, which didn't provide any guidance on how to use it. I was eventually able to find the README which provided the necessary command line parameter, --tap-stream.

I propose that the long_description should contain the README or at least link to it as the primary documentation and not present tappy docs as their own.

@mblayman
Copy link
Member

Thanks for the report! That addition makes sense to me. I'd happily accept a PR that updates the long description to refer to the README.

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

2 participants