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

improve the documentation of gs_design_ahr and gs_power_ahr #501

Conversation

LittleBeannie
Copy link
Collaborator

@LittleBeannie LittleBeannie commented Feb 18, 2025

Update the @param, @return and delete the @section in gs_design_ahr and gs_power_ahr.

@LittleBeannie LittleBeannie added the documentation Improvements or additions to documentation label Feb 18, 2025
@LittleBeannie LittleBeannie self-assigned this Feb 18, 2025
@LittleBeannie
Copy link
Collaborator Author

Hi @jdblischak, I updated the documentation of gs_design_ahr and gs_power_ahr. Please review and check if everything is clearer now.

Copy link
Collaborator

@jdblischak jdblischak left a comment

Choose a reason for hiding this comment

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

This is great! The difference between gs_design_ahr() and gs_power_ahr() is much clearer now, and I appreciate the new details about the return object.

My only request is that the key distinction in the Description ("Calculate sample size and bounds given the power" for gs_design_X() and "Calculate the power given the sample size" for gs_power_X()) be propagated to all the gs_design_X() and gs_power_X() functions. My initial confusion arose when comparing gs_design_wlr() and gs_power_wlr(), and the Description for these functions in unchanged. You can address this request in this PR or in a a follow-up one.

@LittleBeannie LittleBeannie merged commit 0969b30 into main Feb 27, 2025
7 checks passed
@LittleBeannie LittleBeannie deleted the 500-improve-the-documentation-and-spec-of-gs_design_ahrand-gs_power_ahr branch February 27, 2025 15:59
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.

Improve the documentation and spec of gs_design_ahrand gs_power_ahr
3 participants