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

doc: plugin link on readme.rst fixed #8620

Merged

Conversation

freelancing-solutions
Copy link
Contributor

@freelancing-solutions freelancing-solutions commented May 2, 2021

Close #8619.

@freelancing-solutions
Copy link
Contributor Author

document fix ,
Plugin list link is broken
a working link has been relocated to :
plugin list

@nicoddemus
Copy link
Member

Thanks @freelancing-solutions.

While usually we point to the stable docs, I think it makes sense here to point to latest instead.

@nicoddemus nicoddemus mentioned this pull request May 3, 2021
Copy link
Member

@The-Compiler The-Compiler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed that it makes more sense to point to latest here, especially because that page doesn't exist in stable at all.

However, I guess the version switch is a bit worrying though (if a user clicks through to the plugin list and then uses the docs menu, they'll end up with potentially "wrong" (i.e. too new) documentation, without noticing.

Not sure what to do here.

@nicoddemus
Copy link
Member

However, I guess the version switch is a bit worrying though (if a user clicks through to the plugin list and then uses the docs menu, they'll end up with potentially "wrong" (i.e. too new) documentation, without noticing.

But we don't include the README.rst file in the docs, so the only way for the user to use this link is through GitHub, unless I'm missing something. 🤔

@The-Compiler
Copy link
Member

Ah, right, I missed that! Let's merge this then.

@The-Compiler The-Compiler merged commit 385988c into pytest-dev:main May 5, 2021
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 this pull request may close these issues.

bug: broken link on readme.md
3 participants