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 additional clarifying details to documentation guide (in developer's guide) #1315
Conversation
Ignore the boxcox.py change, that was meant to be separate (see #1314). @GuzalBulatova, @SveaMeyer13, @Lovkush-A and @aiwalter can you look at the read the docs build from this PR and let me know if:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the extra information included. Suggestions are:
- typos
- slight rewordings which i think are clearer or more concise
- inclusion of good examples section
Typos outside of changes in this PR (and so I cannot suggest directly in the code...) Line 14. |
Co-authored-by: Lovkush <lovkush@gmail.com>
Co-authored-by: Lovkush <lovkush@gmail.com>
Co-authored-by: Lovkush <lovkush@gmail.com>
Co-authored-by: Lovkush <lovkush@gmail.com>
Co-authored-by: Lovkush <lovkush@gmail.com>
Co-authored-by: Lovkush <lovkush@gmail.com>
Co-authored-by: Lovkush <lovkush@gmail.com>
Thanks for pointing those out. I'll push a commit to fix them. |
Co-authored-by: Lovkush <lovkush@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good! (note that in contractbleBOSS, the joint reference [1,2] did not become a hyperlink)
@Lovkush-A thanks for taking a look and approving. Do you mind opening a PR to fix the link rendering in ContractableBoss? |
I can do it in my PR in which I am updating three or four other docstrings. I think I read the CI/CD system is strugging and that having fewer PRs should help. |
@mloning are you fine if we merge this since it only affects docs? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, this has been reviewed so happy for this to go in
Now merged - thanks @RNKuhns! |
Reference Issues/PRs
Relates to #1245
What does this implement/fix? Explain your changes.
Based on feedback during the docsprint, I've included clarifying content to the documentation portion of the developer guide.
Does your contribution introduce a new dependency? If yes, which one?
Are the added clarifying details clear enough that developers can easily follow them?
Are there other areas where clarification is needed?
What should a reviewer concentrate their feedback on?
Any other comments?
PR checklist
For all contributions
For new estimators