cal-adapt / climakitae

A Python toolkit for retrieving, visualizing, and performing scientific analyses with data from the Cal-Adapt Analytics Engine.
https://climakitae.readthedocs.io
BSD 3-Clause "New" or "Revised" License
19 stars 2 forks source link

Remove ill-formatted documentation #394

Closed Tianchi-Liu closed 1 month ago

Tianchi-Liu commented 1 month ago

Description of PR

Summary of changes and related issue

Relevant motivation and context Improve presentation of the documentation.

Type of change

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.

Checked the preview: https://climakitae--394.org.readthedocs.build/en/394/

Checklist:

Tianchi-Liu commented 1 month ago

Documentation: fix format errors

claalmve commented 1 month ago

Hey Tianchi! I love the documentation improvement, it is definitely a lot more readable now.

I am still getting params showing up as text beneath class names-- is this to be expected? I think the individual attributes show up well and are clear of what they're describing, but the param text beforehand just seems a bit busy.

image

image

Tianchi-Liu commented 1 month ago

I am still getting params showing up as text beneath class names-- is this to be expected? I think the individual attributes show up well and are clear of what they're describing, but the param text beforehand just seems a bit busy.

Yes, they are kept there because they do add a little useful information, but I agree they are not the most readable, so I removed them as well. Does the documentation look better now?

We’ll properly document param-related features hopefully soon.

claalmve commented 1 month ago

I am still getting params showing up as text beneath class names-- is this to be expected? I think the individual attributes show up well and are clear of what they're describing, but the param text beforehand just seems a bit busy.

Yes, they are kept there because they do add a little useful information, but I agree they are not the most readable, so I removed them as well. Does the documentation look better now?

We’ll properly document param-related features hopefully soon.

Yes! Documentation definitely looks more readable now. This may be a thought for a future iteration, but we will most likely want to specify what each of these parameters per class mean and what are the available options.

PR looks good to me though! Thanks @Tianchi-Liu !