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

Fix Julia documentation. #2373

Merged
merged 4 commits into from Apr 20, 2020
Merged

Fix Julia documentation. #2373

merged 4 commits into from Apr 20, 2020

Conversation

Yashwants19
Copy link
Member

This PR is created to fix Julia documentation as discussed with @rcurtin. The info, help, version and copy_all_inputs inputs aren't actually a part of the Julia binding as printed in the binding documentation.

Copy link
Member

@birm birm left a comment

Choose a reason for hiding this comment

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

I think this looks reasonable. I don't know the context to this conversation, though.

Copy link
Member

@rcurtin rcurtin left a comment

Choose a reason for hiding this comment

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

Hey @Yashwants19, thanks for writing up a quick fix for this. It looks good to me, just one comment about the Python bindings and I think it should be good to go. (Also, maybe we should add something to HISTORY.md?)

.ci/macos-steps.yaml Outdated Show resolved Hide resolved
src/mlpack/bindings/python/print_doc_functions_impl.hpp Outdated Show resolved Hide resolved
src/mlpack/bindings/julia/print_doc_functions_impl.hpp Outdated Show resolved Hide resolved
@Yashwants19
Copy link
Member Author

Hi @rcurtin I have updated HISTORY.md as suggested.
Thank You.

@rcurtin
Copy link
Member

rcurtin commented Apr 18, 2020

Awesome, thank you! 👍 Let's make sure the build passes, then I'll approve and merge. :)

Copy link

@mlpack-bot mlpack-bot bot left a comment

Choose a reason for hiding this comment

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

Second approval provided automatically after 24 hours. 👍

Copy link
Member

@zoq zoq left a comment

Choose a reason for hiding this comment

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

Thanks, this looks good!

@rcurtin rcurtin merged commit 3068378 into mlpack:master Apr 20, 2020
@rcurtin
Copy link
Member

rcurtin commented Apr 20, 2020

When 3.3.1 is released, this should be propagated to the stable documentation pages. Tonight, the website rebuild should update the mlpack-git documentation. Thanks! 👍

@Yashwants19 Yashwants19 deleted the Fix-Julia-Doc branch April 21, 2020 03:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants