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

Render API Reference page #140

Merged
merged 1 commit into from
Jun 7, 2024
Merged

Render API Reference page #140

merged 1 commit into from
Jun 7, 2024

Conversation

lukem12345
Copy link
Member

Close #139

In this PR, I tried to resolve the referenced issue by explicitly listing all modules and submodules.

Someone should double check that all the modules that we want to include in the docs page are included. (And only those modules we want included.)

I replaced the reference to IDAllocator with one to PartsType.

Further, I cannot render the docs locally due to the following issues that I cannot resolve myself due to lack of familiarity with the internals :

  • DefaultVecMap has no docstring. (This may be referring to a different type now?)
  • Record has no docstring. (Is it possible to add a docstring for the field of a struct?)
    I temporarily resolved those two bullets by removing the ref in both cases.

I did not review any docstrings aside from those causing those immediate errors.

This is about as far as I can take this issue to being closed. But let me know if there are any commits I can take care of. Thanks!

Copy link

codecov bot commented Jun 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.95%. Comparing base (a24aeea) to head (eaa6c3f).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #140      +/-   ##
==========================================
+ Coverage   91.81%   91.95%   +0.14%     
==========================================
  Files          23       23              
  Lines        2088     2088              
==========================================
+ Hits         1917     1920       +3     
+ Misses        171      168       -3     

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

@lukem12345 lukem12345 marked this pull request as ready for review June 5, 2024 17:50
@olynch olynch merged commit 80abf4f into main Jun 7, 2024
9 checks passed
@lukem12345 lukem12345 deleted the llm/apiref branch June 7, 2024 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API Reference page not loading
3 participants