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
docs: Delete redundant characters. #64
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @luc4leone and thanks for the contribution! As you've seen in the contributing guidelines, the documentation is generated from the code. Therefore, you shouldn't change the HTML files directly, because they will be overridden by the next build. Instead, you should change the docs in the code.
In that case, I think the issue comes from the fact that the original link has an anchor that has parentheses in them (bad Markdown parsing). However, the following link should work to and not cause issues: https://en.wikipedia.org/wiki/ISO_4217#Treatment_of_minor_currency_units_.28the_.22exponent.22.29
I'll let you fix it in the right place 🙂
Sorry @sarahdayan, I read the contributing guidelines, but clearly not as carefully as I should have. I didn't get the point that the docs are generated from the code. Since I didn't know JSDoc, I read its documentation to understand. After some experimenting I think I identified the right place: it's in the I deleted the 2 parenthesis in the url and after executing in my terminal |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @luc4leone, almost there! Your edited docs/index.html
is still in the PR. Can you please revert that change before we can merge?
I deleted the first incorrect commit @sarahdayan |
Hi @luc4leone, there are still things to fix:
Once both are fixed, I'll merge your PR. |
I'll take care of them this week, thanks @sarahdayan! |
@luc4leone Any new on this? 🙂 |
Hey @sarahdayan ;-) will take care of it tomorrow. |
Actually I didn't want to open a new PR @sarahdayan, see #124, but I guess that by targeting |
We can continue on #124 :) Closing this one. |
Delete in an HTML anchor tag these characters "(", ">)" because they resulted in a typo.
Types of changes
Compliance