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

Organize API-doc #2104

Merged
merged 6 commits into from
Dec 6, 2023
Merged

Organize API-doc #2104

merged 6 commits into from
Dec 6, 2023

Conversation

purva-thakre
Copy link
Collaborator

No description provided.

docs/source/conf.py Outdated Show resolved Hide resolved
@purva-thakre purva-thakre marked this pull request as ready for review December 2, 2023 17:12
Copy link

codecov bot commented Dec 2, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c8b6425) 98.31% compared to head (61f1710) 98.31%.
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2104   +/-   ##
=======================================
  Coverage   98.31%   98.31%           
=======================================
  Files          87       87           
  Lines        4142     4142           
=======================================
  Hits         4072     4072           
  Misses         70       70           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@natestemen natestemen left a comment

Choose a reason for hiding this comment

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

Nice! Overall I really like this reorganization. The one thing that isn't totally clear to me is how "Tools for EM Techniques" is different from "Core Utilities". I'm struggling to come up with names to help disambiguate the two, but if you can, I'd love to see! If not, let's roll with what we have.

docs/source/apidoc.md Outdated Show resolved Hide resolved
docs/source/apidoc.md Outdated Show resolved Hide resolved
@natestemen natestemen added the documentation Improvements or additions to documentation label Dec 5, 2023
@natestemen natestemen added this to the 0.32.0 milestone Dec 5, 2023
@purva-thakre
Copy link
Collaborator Author

The one thing that isn't totally clear to me is how "Tools for EM Techniques" is different from "Core Utilities". I'm struggling to come up with names to help disambiguate the two, but if you can, I'd love to see! If not, let's roll with what we have.

Yeah, I really struggled with the labels for the two. The current labels are what I could come up with.

Or we could have 1 section for EM techniques and another labeled Core Utilities. Get rid of Tools for EM Techniques

Copy link
Member

@natestemen natestemen left a comment

Choose a reason for hiding this comment

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

Yeah, let's just go with what you've got. Thanks for suggesting this and making it happen quickly!

docs/source/apidoc.md Outdated Show resolved Hide resolved
Co-authored-by: nate stemen <nate@unitary.fund>
@purva-thakre purva-thakre merged commit 6e9351d into master Dec 6, 2023
15 of 16 checks passed
@purva-thakre purva-thakre deleted the organize_api_doc branch December 6, 2023 01:23
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.

2 participants