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

Do not use ; in code examples #134

Open
cbrnr opened this issue Jan 13, 2025 · 2 comments
Open

Do not use ; in code examples #134

cbrnr opened this issue Jan 13, 2025 · 2 comments

Comments

@cbrnr
Copy link

cbrnr commented Jan 13, 2025

Just a minor suggestion, if you don't have a good reason to suppress output by appending ; to a statement, I would suggest to not do that. For example, the slightly longer example in the README should probably not need to use it.

(This issue is part of openjournals/joss-reviews#6641)

@behinger
Copy link
Member

indeed - I think we used that code in Documenter.jl + Literate.jl , where sometimes not surpressing output results in loooooong dataframes to be plotted in full.

We'll fix it, thanks

@cbrnr
Copy link
Author

cbrnr commented Jan 13, 2025

Yes, it makes sense to suppress output e.g. in the docs, but maybe try to avoid it at least in code examples?

jschepers pushed a commit that referenced this issue Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants