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

The documentation contains some non-descriptive link texts. #7617

Closed
remigathoni opened this issue Mar 13, 2023 · 4 comments
Closed

The documentation contains some non-descriptive link texts. #7617

remigathoni opened this issue Mar 13, 2023 · 4 comments

Comments

@remigathoni
Copy link
Contributor

What is your issue?

I've been going through the docs and noticed some links could be more descriptive.

Here are a few examples with options on how we could rewrite them:

With more specific link texts, you get a clearer idea of what to expect when you click on the link which improves the reading experience. It also makes the links more accessible.

@remigathoni remigathoni added the needs triage Issue that has not been reviewed by xarray team member label Mar 13, 2023
@TomNicholas TomNicholas added topic-documentation contrib-good-first-issue and removed needs triage Issue that has not been reviewed by xarray team member labels Mar 13, 2023
@TomNicholas
Copy link
Member

Thanks @remigathoni ! We would welcome a pull request that made these improvements 🙂

@remigathoni
Copy link
Contributor Author

Thanks @remigathoni ! We would welcome a pull request that made these improvements 🙂

I'll open a PR thanks @TomNicholas !

@Amisha2778
Copy link

Hey @TomNicholas
I am an Outreachy applicant. I would like to work on this issue.

@TomNicholas
Copy link
Member

Hi @Amisha2778 - unfortunately this issue has already been resolved by pull request #7625. We just forgot to close this issue once it was resolved, sorry about that! (The closing normally happens automatically but apparently didn't this time.)

You are welcome to work on any other issue you like, but I will close this one now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants