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.

Sign up for GitHub

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

Jump to bottom

Organize algos and title case all pages #2164

Merged
merged 3 commits into from
Oct 30, 2020
Merged

Organize algos and title case all pages #2164

merged 3 commits into from
Oct 30, 2020

Conversation

nicolengsy
Copy link
Contributor

Made some changes to the documentation so that it's more easy to navigate:

  • Alphabetized algorithms in sidebar
  • Titled algorithms by acronym in sidebar
  • Titled algorithms by "Full name (acronym)" on their actual pages
  • Title-cased all pages

This is not linked to an issue; would love any suggestions on this!

@nicolengsy nicolengsy requested a review from a team as a code owner October 29, 2020 19:02
@nicolengsy nicolengsy requested review from krzentner and removed request for a team October 29, 2020 19:02
@mergify mergify bot requested review from a team, ziyiwu9494 and maliesa96 and removed request for a team October 29, 2020 19:02
@codecov
Copy link

codecov bot commented Oct 29, 2020 •
edited
Loading

Codecov Report

Merging #2164 into master will increase coverage by 0.05%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2164      +/-   ##
==========================================
+ Coverage   91.47%   91.52%   +0.05%     
==========================================
  Files         197      197              
  Lines       10836    10836              
  Branches     1356     1356              
==========================================
+ Hits         9912     9918       +6     
+ Misses        669      666       -3     
+ Partials      255      252       -3
Impacted Files Coverage Δ
src/garage/np/_functions.py 86.06% <0.00%> (+1.63%) ⬆️
...rage/tf/optimizers/conjugate_gradient_optimizer.py 83.71% <0.00%> (+1.80%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fbafdef...118010c. Read the comment docs.

yeukfu
yeukfu approved these changes Oct 29, 2020
View reviewed changes
Copy link
Contributor

@yeukfu yeukfu left a comment

Choose a reason for hiding this comment

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

LGTM

@mergify mergify bot requested a review from a team October 29, 2020 20:32
@mergify mergify bot requested a review from a team October 30, 2020 16:40
ryanjulian
ryanjulian approved these changes Oct 30, 2020
View reviewed changes
Copy link
Member

@ryanjulian ryanjulian left a comment

Choose a reason for hiding this comment

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

Thank you so much for this!

@mergify mergify bot merged commit 3b3ad04 into master Oct 30, 2020
@mergify mergify bot deleted the nn_organize_docs branch October 30, 2020 18:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@krzentner krzentner krzentner approved these changes

@avnishn avnishn avnishn approved these changes

@yeukfu yeukfu yeukfu approved these changes

@ryanjulian ryanjulian ryanjulian approved these changes

@ziyiwu9494 ziyiwu9494 Awaiting requested review from ziyiwu9494

@maliesa96 maliesa96 Awaiting requested review from maliesa96

Assignees
No one assigned
Labels
documentation ready-to-merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@nicolengsy @ryanjulian @yeukfu @avnishn @krzentner