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 #283

Merged
merged 26 commits into from
Nov 19, 2024
Merged

Update documentation #283

merged 26 commits into from
Nov 19, 2024

Conversation

StijnKas
Copy link
Collaborator

One of the main remaining items for V4 is/was documentation. In this PR, I've setup some infra changes to make publishing new documentation pieces easier and also added some documentation to certain classes and methods.

Additionally, with the goal of moving away from the wiki (for various reasons), this PR contains some of the getting started code that used to be in the wiki, directly in the Python docs.

I've also moved and shifted around some of the main init import logic and made certain classes not available top-level. Let's see if that gives us any issues down the line.

Copy link

codecov bot commented Nov 19, 2024

Codecov Report

Attention: Patch coverage is 32.14286% with 57 lines in your changes missing coverage. Please review.

Project coverage is 61.33%. Comparing base (399ae8f) to head (80b7689).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
python/pdstools/cli.py 0.00% 36 Missing ⚠️
python/pdstools/utils/show_versions.py 10.00% 18 Missing ⚠️
python/pdstools/decision_analyzer/decision_data.py 0.00% 2 Missing ⚠️
python/pdstools/adm/ADMDatamart.py 88.88% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #283      +/-   ##
==========================================
+ Coverage   58.47%   61.33%   +2.85%     
==========================================
  Files          56       56              
  Lines        4918     4717     -201     
==========================================
+ Hits         2876     2893      +17     
+ Misses       2042     1824     -218     

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


🚨 Try these New Features:

@StijnKas
Copy link
Collaborator Author

Pretty much closes #278

@StijnKas StijnKas merged commit 2c55fc9 into pegasystems:master Nov 19, 2024
3 of 9 checks passed
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.

1 participant