Correction of Various Documentation Issues #11091
Conversation
Various commits to .tex and .rst files to correct issues with the documentation noted by a variety of defect issues. The one code change is the correction of a comment line only.
|
This is ready for some review. I have built the readthedocs html files for the docs that changed locally and the corrections I made seem to be good. Of course, all of the IDFs that changed were also built locally and seem ready also. If there are any issues, please let me know and I'll be happy to make corrections. Thanks! |
Myoldmopar
left a comment
There was a problem hiding this comment.
I think I'd like to see at least the one table I commented on cleaned up just a little more while we're already in there. The full set of markdown docs from this branch are shown here: The docs from this branch are built here https://energyplus.readthedocs.io/en/10605documentationissues2024b/, and that should be updated after any commits to this branch. So if you want to test out more changes, just push your commit, give it 5 minutes to build, and refresh that page.
| 7:01- 8:00 59 49 46 50 44 31 50 46 52 40 49 38 | ||
| 8:01- 9:00 62 51 50 46 40 29 43 36 47 43 48 43 | ||
| 9:01-10:00 61 53 43 41 37 26 37 32 34 38 43 44 | ||
| Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec |
There was a problem hiding this comment.
Is the data actually coming out like this? I don't really have a strong opinion about adjusting this text, but I wouldn't want to mislead someone who might be parsing the output.
There was a problem hiding this comment.
I'll double check this. I did look at an existing .stat file as a guide, but I'll take another look and fix what is still off.
There was a problem hiding this comment.
It took a couple of attempts to figure a few things out, but I think this is now cleaned up and looking much better now.
| +----------------+----------------+----------------+----------------+ | ||
| | horirsky | horizon | W | Y | | ||
| | | tal_infrared\_ | h m\ :sup:`−2` | | | ||
| | | tal_infrared_ | h m\ :sup:`−2` | | |
There was a problem hiding this comment.
I think this table still needs love. Would you want to give this another pass? https://energyplus.readthedocs.io/en/10605documentationissues2024b/auxiliary-programs/auxiliary-programs.html#id68
If not, I can. The table is really just too skinny. I would try to use a tool like https://www.tablesgenerator.com/text_tables to paste in the data and have it generate a nice fully formed version.
There was a problem hiding this comment.
I can look at this further and fully clean this table up.
There was a problem hiding this comment.
I've cleaned this and I think all of the other tables in this area up. Shouldn't be any stray spaces or other "glitches" in these tables now.
Additional changes were made to the Auxiliary Programs document, particularly in the Weather section.
Still getting the hang of working with this...obviously!
Getting closer...this might be it?
|
@RKStrand @Myoldmopar it has been 28 days since this pull request was last updated. |
| | liq_precip_depth | liquid_precip_depth | mm | Y | | ||
| +-------------------+--------------------------------------------------+------------------+------------+ | ||
| | liq_precip_rate | liquid_precip_rate | h | N | | ||
| +-------------------+--------------------------------------------------+------------------+------------+ |
|
This looks much better now. There's something funny on the table causing some rows to be taller? https://energyplus.readthedocs.io/en/10605documentationissues2024b/auxiliary-programs/auxiliary-programs.html#id69 But it's super super minor, and not worth holding this up. Let's get this merged. Thanks @RKStrand |
Various commits to .tex and .rst files to correct issues with the documentation noted by a variety of defect issues. The one code change is the correction of a comment line only. This addresses the following defects:
Pull request overview
Description of the purpose of this PR
The purpose of this PR is to correct various documentation errors: typos, improper placement of text, missing sections, etc. As this is a documentation only PR, there are no unit tests included with it.
Pull Request Author
Reviewer