chore: Add word wrapping to text sections as necessary

uw-ssec / tutorials

SSEC tutorials for various topics

https://uw-ssec-tutorials.readthedocs.io

BSD 3-Clause "New" or "Revised" License

3 stars 3 forks source link

chore: Add word wrapping to text sections as necessary #70

Open nikiburggraf opened 3 months ago

nikiburggraf commented 3 months ago

Especially natural language outputs, needing to scroll to the side seems to (to me, at least) diminish readability.

In addition, restructuring code line lengths with a limit of 80 characters (where/when it makes sense) would likely let code snippets be displayed without needing to scroll to the side.

lsetiawan commented 2 months ago

Could you maybe add screenshot on this? Also, is this a nice to have or absolute must be done before demo on Tuesday?

nikiburggraf commented 2 months ago

This is definitely more nice-to-have than required.

It's most visible on the read-the-docs page

As a counterexample, this is what it looks like in VSCode in a codespace

but that's with this setting ticked, and I do not remember what the default is (and I have no idea what the default would be on Nebari for the actual tutorial run at SciPy):

lsetiawan commented 2 months ago

Ah, gotcha, this is a jupyterbook rendering customization I think.. Thanks for providing these screenshot. I'll put it as enhancement, rather than a must to-do at this time. 😄