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

Doc improvements #335

Merged
merged 5 commits into from
Jan 4, 2024
Merged

Doc improvements #335

merged 5 commits into from
Jan 4, 2024

Conversation

d-chambers
Copy link
Contributor

Description

This PR:

  • Adds examples for some top-level DASCore functions
  • Improves the site styling by tweaking the css
  • Makes example patch functions public
  • Adds a function for getting a dataframe of functions, their cross links, and descriptions.

Checklist

I have (if applicable):

  • referenced the GitHub issue this PR closes.
  • documented the new feature with docstrings or appropriate doc page.
  • included a test. See testing guidelines.
  • your name has been added to the contributors page (docs/contributors.md).
  • added the "ready_for_review" tag once the PR is ready to be reviewed.

@d-chambers d-chambers added the documentation Improvements or additions to documentation label Jan 3, 2024
Copy link

codecov bot commented Jan 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9ade640) 99.51% compared to head (75f6528) 99.52%.
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #335      +/-   ##
==========================================
+ Coverage   99.51%   99.52%   +0.01%     
==========================================
  Files          92       91       -1     
  Lines        7170     7191      +21     
==========================================
+ Hits         7135     7157      +22     
+ Misses         35       34       -1     
Flag Coverage Δ
unittests 99.52% <100.00%> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@d-chambers d-chambers merged commit a11438c into master Jan 4, 2024
15 checks passed
@d-chambers d-chambers deleted the doc_tables branch January 4, 2024 20:55
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.

1 participant