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 developers doc; accordingly rename abstract supertypes #72

Merged
merged 12 commits into from
Feb 19, 2024
Merged

Conversation

Datseris
Copy link
Member

Closes #71

This adds a new page "Developers docs" that outlines how to contribute new pipelines to the software.

Additionally, I renamed the abstract types, and the core documentation strings, to talk about only two things: "changes" and "statistically significant changes" the latter being equivalent with "transitions".

I wanted to move away from referring to "indicators" all the time, as we have already discussed that sometimes an indicator is not used, only a change metric is used.

@Datseris Datseris requested a review from JanJereczek February 15, 2024 11:57
@codecov-commenter
Copy link

Codecov Report

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

Comparison is base (b1d3387) 36.42% compared to head (9e1706c) 45.22%.

Files Patch % Lines
src/significance/basic_stat_significance.jl 0.00% 3 Missing ⚠️
src/analysis/segmented_window.jl 0.00% 1 Missing ⚠️
src/significance/api_significance.jl 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #72      +/-   ##
==========================================
+ Coverage   36.42%   45.22%   +8.79%     
==========================================
  Files          18       17       -1     
  Lines         442      356      -86     
==========================================
  Hits          161      161              
+ Misses        281      195      -86     

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

@Datseris Datseris merged commit b4fc84c into main Feb 19, 2024
1 of 3 checks passed
@Datseris Datseris deleted the devdocs branch February 19, 2024 20:53
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.

Add developers docs page: Adding new "anything"
2 participants