-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Missing Descriptions for Formula Components in haydavies
#2183
Comments
haydavies
Functionhaydavies
haydavies
haydavies
Function
haydavies
Functionhaydavies
I do agree that it seems poorly documented and that the other variables should be defined. While we're at it, equations such as these belong in the Notes section of the documentation. @BernatNicolau are you up for making a PR to improve the haydavies function? |
I will try to work on it but I don't think I will be able to prioritize it. I will post a comment when I start to work on the PR, so if anyone feels like doing it, go ahead :) |
I'd be happy to work on the documentation for at least one of these functions. I don't want to hijack your work here though @BernatNicolau , let me know if you were planning to make a start soon and/or whether my contribution would be helpful here.
I think this single issue is sufficient but separate PRs for each function might help with overall organisation of these developments. |
Hi @RDaxini ! Please go ahead, I don't intend to start documenting this anytime soon ;) It was great meeting you as well! That introductory class was what I needed to start contributing, so thank you for that!! Hope to see you again somewhere soon :) |
@BernatNicolau happy to hear the tutorial was helpful! I have created a few PRs on this subject. Feel free to leave a review (another great type of contribution) if you have time! Your thoughts on the comments I have left or any of the code edits would be more than welcome. If you'd like some help with using any of the review features on github too then let us know. |
The formula components for the
haydavies
function seems to not be properly defined. The current formula is:However, the documentation does not provide definitions or explanations for the components$A$ and $R_b$ . While $DHI$ and $\beta$ are relatively straightforward, I feel it would be beneficial to include their descriptions for completeness.
Additionally,
isotropic
,klutcher
andreindl
also lack description of formula components.Request
Update the documentation for the
haydavies
function to include descriptions for the following components:Update the documentation for the
isotropic
,klutcher
andreindl
(shall different issues be created for each function?)I think that providing these definitions will improve clarity.
Thank you!
The text was updated successfully, but these errors were encountered: