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

Update documentation #297

Merged
merged 2 commits into from
Oct 31, 2023
Merged

Update documentation #297

merged 2 commits into from
Oct 31, 2023

Conversation

ffl096
Copy link
Member

@ffl096 ffl096 commented Oct 30, 2023

This closes #95. Crossref. pyt-team/TopoEmbedX#35 and pyt-team/TopoModelX#246.

@codecov
Copy link

codecov bot commented Oct 30, 2023

Codecov Report

Attention: 5 lines in your changes are missing coverage. Please review.

Comparison is base (ada1f19) 97.36% compared to head (fc73e9c) 97.29%.
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #297      +/-   ##
==========================================
- Coverage   97.36%   97.29%   -0.08%     
==========================================
  Files          29       29              
  Lines        3375     3359      -16     
==========================================
- Hits         3286     3268      -18     
- Misses         89       91       +2     
Files Coverage Δ
toponetx/algorithms/components.py 95.23% <100.00%> (ø)
toponetx/algorithms/distance.py 100.00% <100.00%> (ø)
toponetx/algorithms/distance_measures.py 100.00% <100.00%> (ø)
toponetx/algorithms/spectrum.py 100.00% <100.00%> (ø)
toponetx/classes/cell.py 100.00% <100.00%> (ø)
toponetx/classes/cell_complex.py 99.22% <100.00%> (-0.01%) ⬇️
toponetx/classes/colored_hypergraph.py 89.72% <100.00%> (-0.11%) ⬇️
toponetx/classes/combinatorial_complex.py 92.64% <100.00%> (-0.14%) ⬇️
toponetx/classes/complex.py 100.00% <100.00%> (ø)
toponetx/classes/hyperedge.py 100.00% <100.00%> (ø)
... and 9 more

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

- Add numpydoc for more consistency with their documentation and for docstring validation.
- Setup intersphinx (see #296).
- Fix documentation issues raised by numpydoc.
@ffl096 ffl096 mentioned this pull request Oct 30, 2023
@mhajij mhajij merged commit 1ff5a45 into main Oct 31, 2023
4 of 6 checks passed
@ffl096 ffl096 deleted the frantzen-docs branch October 31, 2023 07:22
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.

Clean docstrings and API
2 participants