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

documentation is missing newlines in contexts affecting fluent comprehension #126

Open
matanox opened this issue Feb 1, 2024 · 1 comment

Comments

@matanox
Copy link

matanox commented Feb 1, 2024

& I don't mean to be petty but the doc page seems to miss newlines in those paragraphs describing arguments, they seem to be swallowed resulting in every argument description whereby a plain space character delimitation is used instead. Simple newlines can make it so much more useful to read with deaper comprehension and presumably save up on questions, as it's not allowing much fluency in skimming and browsing as is.

https://klepto.readthedocs.io/en/latest/#klepto.inf_cache

It would really improve coherence for users ... almost as much as usage examples for key workflows appended at the top or bottom.

@matanox matanox changed the title documentation is missing newlines in contexts where fluent reading is undermined documentation is missing newlines in contexts affecting fluent comprehension Feb 1, 2024
@mmckerns
Copy link
Member

I agree, and I know it's an issue. I'm working through formatting of the docs on all the UQ Foundation packages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants