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.

Sign up for GitHub

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

Jump to bottom

Add a sample of output IDF strings to each to_idf method #37

Open
chriswmackey opened this issue Oct 19, 2019 · 0 comments
Open

Add a sample of output IDF strings to each to_idf method #37

chriswmackey opened this issue Oct 19, 2019 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@chriswmackey
Copy link
Member

chriswmackey commented Oct 19, 2019 •
edited
Loading

Adding a sample idf sting of the output to each docstring will be really helpful to know what each of the output objects are. Example for SizingParameter object:

"""Get an EnergyPlus string representation of the SizingParameters.

    .. code-block:: shell

        Sizing:Parameters,
         1.25,                     !- heating factor
         1.15;                     !- cooling factor
"""
@chriswmackey chriswmackey added enhancement New feature or request good first issue Good for newcomers honeybee energy labels Oct 19, 2019
@chriswmackey chriswmackey mentioned this issue Oct 19, 2019
Merged
@chriswmackey chriswmackey added the documentation Improvements or additions to documentation label Nov 27, 2019
@chriswmackey chriswmackey added the help wanted Extra attention is needed label Jun 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@chriswmackey