Sitelet https://web.archive.org/web/20200219094456/https://github.com/keras-team/keras/issues/13701
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

keras docs: long <code> lines need to be rearranged to short lines to be easier to read #13701

Open
lwmv opened this issue Jan 15, 2020 · 0 comments
Labels

Comments

@lwmv
Copy link

@lwmv lwmv commented Jan 15, 2020 •

Some lines in the code block of the keras docs is too long, the result of which is, there will be a horizonal scroll bar at the bottom of the code block. That is hard to read. The long lines should be rearranged to multiple short lines to improve readibility.

Example:
The docs for the SimpleRNN class (https://keras.io/layers/recurrent/#simplernn). The initializer of SimpleRNN has many arguments, but the docs put them in just a single long line. That makes it very hard to read.
docs line too long

The single long line should be rearranged to multiple short lines, just like what was did in the source code for the init function of SimpleRNN.

short lines

JustinL42 added a commit to JustinL42/keras that referenced this issue Jan 28, 2020
…ltiple lines in the docs. The arguments are listed on the initial line and each keyword argument is then printed on its own indented line (keras-team#13701).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.