Question-and-Answer Resource for the Building Energy Modeling Community
Get s tarted with the Help page
Ask Your Question
1

Where to suggest correction to EnergyPlus documentation

asked 2016-03-24 15:42:09 -0500

rkbest gravatar image

updated 2016-03-24 17:46:09 -0500

While going through the documentation at http://bigladdersoftware.com/ I found that there might be broken links to PDFs and some minor errors. My question is where and to whom can I send suggestions for correction.

For example http://bigladdersoftware.com/epx/docs... Figure 21 has the line diagram with inlet pump mentioned while it should be inlet pipe.

There few broken links to PDF's as well on other pages.

edit retag flag offensive close merge delete

Comments

The team just overhauled the documentation process. I think you'll see that new version coincident with the 8.5 release tomorrow. Take another look once it's refreshed and let us know if it's still wonky.

ljbrackney gravatar image ljbrackney  ( 2016-03-24 20:47:33 -0500 )edit

1 Answer

Sort by ยป oldest newest most voted
1

answered 2016-03-25 02:01:15 -0500

I think the right place in on the EnergyPlus Github.

I'd say that if this is a big mistake or one you cannot fix yourself you should maybe open an issue, but otherwise it'd be much better to fork the repository, make the fix, and create a pull request.

GitHub's help pages are pretty good to explain how to do this kind of stuff, see this page in particular.

edit flag offensive delete link more

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

 

Question Tools

1 follower

Stats

Asked: 2016-03-24 15:42:09 -0500

Seen: 93 times

Last updated: Mar 25 '16