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

add some basic documentation #54

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
Draft

Conversation

tdixon97
Copy link
Contributor

No description provided.

Copy link

codecov bot commented Nov 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.71%. Comparing base (ad7b135) to head (c61df21).
Report is 15 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #54      +/-   ##
==========================================
- Coverage   77.86%   77.71%   -0.15%     
==========================================
  Files          16       15       -1     
  Lines         768      763       -5     
==========================================
- Hits          598      593       -5     
  Misses        170      170              

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

docs/source/manual.rst Outdated Show resolved Hide resolved
docs/source/manual.rst Outdated Show resolved Hide resolved
docs/source/manual.rst Outdated Show resolved Hide resolved
@gipert gipert marked this pull request as draft January 16, 2025 10:14
editable install should become a developer guide at some point
@ManuelHu
Copy link
Collaborator

ManuelHu commented Feb 3, 2025

I addressed the two outstanding open issues from my review, and also some other things that changed in the mean time (i.e. pygeom-l200 no longer being private).

Even though this is still very simple, I think this can be merged @gipert @tdixon97 ?

@gipert
Copy link
Member

gipert commented Feb 3, 2025

I would like to review it.

Also I would convert to markdown and enable the prettier pre-commit hook.

@gipert gipert self-requested a review February 3, 2025 16:10
@ManuelHu
Copy link
Collaborator

ManuelHu commented Feb 3, 2025

prettier is enabled, but just does not work on rst files...

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.

3 participants