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

Gender Rates are Not Documented Well on Website #481

Open
justingolden21 opened this issue Apr 1, 2020 · 3 comments
Open

Gender Rates are Not Documented Well on Website #481

justingolden21 opened this issue Apr 1, 2020 · 3 comments

Comments

@justingolden21
Copy link

@justingolden21 justingolden21 commented Apr 1, 2020

Issue and Reproduction

Gender rates are not well documented on the API website

On the website I scrolled through every possible bit about gender to figure out what the number could possibly mean. Only upon finding the README do I find:

The chance of this Pokémon being female, in eighths; or -1 for genderless

While almost all other information on every other topic is near identical if not identical between the website and the README.

Expected Behavior

Add the quoted info above:

The chance of this Pokémon being female, in eighths; or -1 for genderless

To the website at the address: https://pokeapi.co/docs/v2.html/#genders

I found it very inconvenient that despite the website being so well documented, I could not for the life of me find any relevant information on the number returned by the API, and several Google searches failed me until I finally decided to look for the GitHub repo.

Thank You

Thank you for listening to my feedback, I love the API and would love for it to be more easily navigable for others in the future.

@Naramsim
Copy link
Member

@Naramsim Naramsim commented Apr 1, 2020

Hi @justingolden21, I believe there is currently a bug in our documentation.

Can you please browse this page https://pokeapi.co/docs/v2.html and scroll down (without clicking the gender link on the left column) until you find the genders section? If you manage to do it, do you see the correct text?

As of now when I'm browsing https://pokeapi.co/docs/v2.html I get the correct rate description (that you suggested) and when I'm browsing https://pokeapi.co/docs/v2.html/#genders I get rate | The Pokémon that holds this item.

genders

I believe it's an anchor related problem

@Kronopt
Copy link
Member

@Kronopt Kronopt commented Apr 1, 2020

The docs page has been bugged for some time now: Not all resource links (anchors) are working correctly within the page.
@cmmartti was working on a new version of the docs page, I think, but he hasn't been able to help for personal reasons

@justingolden21
Copy link
Author

@justingolden21 justingolden21 commented Apr 2, 2020

@Naramsim

image

That is what I see. Thank you both for looking into this.

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

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.