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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Collapsible code examples in documentation #140

Merged
merged 3 commits into from Nov 19, 2019

Conversation

@jeffin143
Copy link
Contributor

jeffin143 commented Nov 1, 2019

Handling : #139

馃殌 Done

@mlpack-bot

This comment has been minimized.

Copy link

mlpack-bot bot commented Nov 1, 2019

Thanks for opening your first pull request in this repository! Someone will review it when they have a chance. In the mean time, please be sure that you've handled the following things, to make the review process quicker and easier:

  • All code should follow the style guide
  • Documentation added for any new functionality
  • Tests added for any new functionality
  • Tests that are added follow the testing guide
  • Headers and license information added to the top of any new code files
  • HISTORY.md updated if the changes are big or user-facing
  • All CI checks should be passing

Thank you again for your contributions! 馃憤

Copy link
Member

rcurtin left a comment

Hey @jeffin143,

Awesome work! Thanks for taking care of this. I spent a little time with the ensmallen.org code working on getting the CSS right (see mlpack/ensmallen.org@00b0c71).

I don't have any issue if we want to make all the code examples collapsible, but I think we should default to all of them open, except the long example programs in places like this: http://ensmallen.org/docs.html#differentiable-separable-functions (the code right under "This example implementation only implements EvaluateWithGradient() in order to avoid redundant calculations."). There are a couple example programs like that.

We can keep them open by default by using <details open>. 馃憤

doc/callbacks.md Outdated Show resolved Hide resolved
doc/callbacks.md Outdated Show resolved Hide resolved
doc/callbacks.md Outdated Show resolved Hide resolved
doc/callbacks.md Outdated Show resolved Hide resolved
@zoq zoq removed the s: unanswered label Nov 6, 2019
@zoq
zoq approved these changes Nov 17, 2019
Copy link
Member

zoq left a comment

Looks good to me.

Copy link
Member

rcurtin left a comment

Awesome, looks great to me. Thanks so much for handling this! 馃憤

doc/optimizers.md Outdated Show resolved Hide resolved
@mlpack-bot

This comment has been minimized.

Copy link

mlpack-bot bot commented Nov 18, 2019

Hello there! Thanks for your contribution. I see that this is your first contribution to mlpack. If you'd like to add your name to the list of contributors in src/mlpack/core.hpp and COPYRIGHT.txt and you haven't already, please feel free to push a change to this PR---or, if it gets merged before you can, feel free to open another PR.

In addition, if you'd like some stickers to put on your laptop, I'd be happy to help get them in the mail for you. Just send an email with your physical mailing address to stickers@mlpack.org, and then one of the mlpack maintainers will put some stickers in an envelope for you. It may take a few weeks to get them, depending on your location. 馃憤

1 similar comment
@mlpack-bot

This comment has been minimized.

Copy link

mlpack-bot bot commented Nov 18, 2019

Hello there! Thanks for your contribution. I see that this is your first contribution to mlpack. If you'd like to add your name to the list of contributors in src/mlpack/core.hpp and COPYRIGHT.txt and you haven't already, please feel free to push a change to this PR---or, if it gets merged before you can, feel free to open another PR.

In addition, if you'd like some stickers to put on your laptop, I'd be happy to help get them in the mail for you. Just send an email with your physical mailing address to stickers@mlpack.org, and then one of the mlpack maintainers will put some stickers in an envelope for you. It may take a few weeks to get them, depending on your location. 馃憤

Co-Authored-By: Ryan Curtin <ryan@ratml.org>
@jeffin143

This comment has been minimized.

Copy link
Contributor Author

jeffin143 commented Nov 18, 2019

Hello there! Thanks for your contribution. I see that this is your first contribution to mlpack. If you'd like to add your name to the list of contributors in src/mlpack/core.hpp and COPYRIGHT.txt and you haven't already, please feel free to push a change to this PR---or, if it gets merged before you can, feel free to open another PR.

In addition, if you'd like some stickers to put on your laptop, I'd be happy to help get them in the mail for you. Just send an email with your physical mailing address to stickers@mlpack.org, and then one of the mlpack maintainers will put some stickers in an envelope for you. It may take a few weeks to get them, depending on your location. +1

I know @mlpack-bot :), I have been contributing often :-p

@rcurtin

This comment has been minimized.

Copy link
Member

rcurtin commented Nov 19, 2019

Yeah, @mlpack-bot doesn't look across repositories... I was too lazy to get that support working right. :) Sorry about that...

@rcurtin rcurtin merged commit 3e6dbe2 into mlpack:master Nov 19, 2019
2 checks passed
2 checks passed
Static Code Analysis Checks Build finished.
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@rcurtin

This comment has been minimized.

Copy link
Member

rcurtin commented Nov 19, 2019

Awesome, thanks! 馃憤

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can鈥檛 perform that action at this time.