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

Remove extra docstrings and reorder methods for mean and total #117

Merged
merged 4 commits into from
Dec 5, 2022

Conversation

iuliadmtru
Copy link
Contributor

I reordered the methods such that the first methods correspond to the main functionality (calculating the mean of a survey design variable) and the last methods correspond to the by functionality (calculating the mean of a variable from a subpopulation). The very last method is not part of these, we should discuss on issue #109 what to do with it.

After reordering, I removed the docstrings from all methods apart from the first one for each group and I added relevant examples for all methods inside that docstring.

@iuliadmtru iuliadmtru changed the title Remove extra docstrings and reorder methods Remove extra docstrings and reorder methods for mean Dec 4, 2022
@codecov-commenter
Copy link

codecov-commenter commented Dec 4, 2022

Codecov Report

Merging #117 (690a424) into design_update (28d0711) will decrease coverage by 2.69%.
The diff coverage is 0.00%.

@@                Coverage Diff                @@
##           design_update     #117      +/-   ##
=================================================
- Coverage          49.79%   47.09%   -2.70%     
=================================================
  Files                 11       11              
  Lines                492      465      -27     
=================================================
- Hits                 245      219      -26     
+ Misses               247      246       -1     
Impacted Files Coverage Δ
src/mean.jl 24.24% <0.00%> (ø)
src/total.jl 19.14% <0.00%> (ø)
src/SurveyDesign.jl 70.31% <0.00%> (-3.21%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@iuliadmtru
Copy link
Contributor Author

iuliadmtru commented Dec 4, 2022

The documentation for total needs to be changed in the same manner. I'll do this in a bit.

@iuliadmtru iuliadmtru changed the title Remove extra docstrings and reorder methods for mean Remove extra docstrings and reorder methods for mean and total Dec 4, 2022
@ayushpatnaikgit
Copy link
Member

Can you remove the function corresponding to #109?

@smishr smishr self-requested a review December 5, 2022 03:44
Removed strata means option for now. will reformat and add back at later stage.
Copy link
Contributor

@smishr smishr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mean.jl look good. In total.jl docstring tests there are using Survey, Im not sure if they are required? @iuliadmtru @ayushpatnaikgit. otherwise looks good to merge

@smishr
Copy link
Contributor

smishr commented Dec 5, 2022

690a424

Removed it

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.

4 participants