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

Order API reference #111

Merged
merged 1 commit into from
Jul 20, 2024
Merged

Order API reference #111

merged 1 commit into from
Jul 20, 2024

Conversation

ranocha
Copy link
Collaborator

@ranocha ranocha commented Jul 19, 2024

The current version of the API reference docs is just ordered alphabetically by name of things, see https://skopecz.github.io/PositiveIntegrators.jl/v0.1/api_reference/

In this PR, I ordered the API references manually, sorting them by the type of stuff: general problem types, pre-made problems, and algorithms. I think this makes it easier to search the API reference

@ranocha ranocha added the documentation Improvements or additions to documentation label Jul 19, 2024
@ranocha ranocha requested a review from SKopecz July 19, 2024 09:45
@codecov-commenter
Copy link

codecov-commenter commented Jul 19, 2024

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.09%. Comparing base (f86c263) to head (15c6d7f).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #111   +/-   ##
=======================================
  Coverage   98.09%   98.09%           
=======================================
  Files           6        6           
  Lines        1414     1414           
=======================================
  Hits         1387     1387           
  Misses         27       27           

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

@SKopecz
Copy link
Owner

SKopecz commented Jul 19, 2024

The old order was really annoying. Thanks a lot!

@ranocha ranocha merged commit 6845b50 into main Jul 20, 2024
12 checks passed
@ranocha ranocha deleted the ranocha-patch-1 branch July 20, 2024 12:45
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