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 docs #137

Merged
merged 8 commits into from
Nov 6, 2022
Merged

Update docs #137

merged 8 commits into from
Nov 6, 2022

Conversation

thomaspinder
Copy link
Collaborator

Improve the documentation standards. It also makes the documentation's build process more robust.

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

The existing documentation is adequate but far from perfect. This PR seeks to include more worded descriptions, mathematical annotations and code examples to the existing docstrings.

Issue Number: #136

@thomaspinder thomaspinder self-assigned this Nov 6, 2022
@thomaspinder thomaspinder added the documentation Improvements or additions to documentation label Nov 6, 2022
@thomaspinder thomaspinder added this to the v0.5.0 milestone Nov 6, 2022
@thomaspinder thomaspinder linked an issue Nov 6, 2022 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Nov 6, 2022

Codecov Report

Merging #137 (ddfbfab) into v0.5_update (7a51a9e) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@             Coverage Diff              @@
##           v0.5_update     #137   +/-   ##
============================================
  Coverage        98.27%   98.27%           
============================================
  Files               15       15           
  Lines             1331     1332    +1     
============================================
+ Hits              1308     1309    +1     
  Misses              23       23           
Flag Coverage Δ
unittests 98.27% <100.00%> (+<0.01%) ⬆️

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

Impacted Files Coverage Δ
gpjax/gps.py 99.35% <100.00%> (+<0.01%) ⬆️
gpjax/kernels.py 95.08% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@thomaspinder thomaspinder merged commit 8542439 into v0.5_update Nov 6, 2022
@thomaspinder thomaspinder deleted the docs_improve branch November 6, 2022 17:16
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.

dev: Improve documentation
1 participant