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

[docs] Add back references to footnotes #141

Merged
merged 3 commits into from
Oct 16, 2023

Conversation

spier
Copy link
Contributor

@spier spier commented Oct 14, 2023

In #139 the references to the footnotes were accidentally removed.

Proposed Changes

I added back in the references to the footnotes in the top-most table that explains the different metrics.
Also suggested some rewording for better readability.

Readiness Checklist

Author/Contributor

  • If documentation is needed for this change, has that been included in this pull request
  • run make lint and fix any issues that you have introduced
  • run make test and ensure you have test coverage for the lines you are introducing

Reviewer

  • Label as either bug, documentation, enhancement, infrastructure, or breaking

@spier spier requested a review from zkoppert as a code owner October 14, 2023 08:00
@Okabe-Junya
Copy link
Contributor

I am the author of #139.

Thank you for creating the correction PR!! I misunderstood the footnote and accidentally deleted it.

From what I’ve seen, this PR seems to be excellent!!

Copy link
Member

@zkoppert zkoppert left a comment

Choose a reason for hiding this comment

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

Thanks for catching this!!

@zkoppert zkoppert added the documentation Improvements or additions to documentation label Oct 16, 2023
@zkoppert zkoppert merged commit 599280f into github:main Oct 16, 2023
5 checks passed
@spier spier deleted the docs-footnote-fix branch October 16, 2023 19:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants