Skip to content

Update notebooks quotes#448

Merged
JieXiong9119 merged 4 commits intodevelop-v2from
update-notebooks-quotes
Aug 5, 2022
Merged

Update notebooks quotes#448
JieXiong9119 merged 4 commits intodevelop-v2from
update-notebooks-quotes

Conversation

@JieXiong9119
Copy link
Copy Markdown
Contributor

@JieXiong9119 JieXiong9119 commented Jul 14, 2022

Any background context you want to provide?

We recently update the notebook examples folder to have both level 1 and 2 audits for small office prototype building. This PR follows this up to clean up some left tails.

What does this PR do?

Update notebook examples to have consistent quote usage (double quotes), descriptive text and the outputs.

How should this be manually tested?

Convert the Small-Office-Level-1.md and Small-Office-Level-2.md into Jupyter Notebooks to edit and run to create xml outputs.

What are the relevant tickets?

BuildingSync/project-tracker#121

Update all quotes to double quotes to keep consistency
To be consistent with level 2 notebook
@JieXiong9119 JieXiong9119 self-assigned this Jul 14, 2022
@JieXiong9119
Copy link
Copy Markdown
Contributor Author

The validation result image for level 1 example was not updated. The added GHG elements were not updated on the BuildingSync website so the validator gave errors on those elements when validating "example-smalloffice-level1.xml".

Copy link
Copy Markdown
Member

@nllong nllong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice cleanup! Looks great!

Comment thread docs/notebooks/bsync_examples/Small-Office-Level-1.md Outdated
Copy link
Copy Markdown
Contributor

@laurenliz22 laurenliz22 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey Jie - saw that "isn't" was changed to "isn"t'. Don't think this was in more than one place, but I can also not view the Level 2 audit for some reason (diff isn't loading). Can you just make sure? Otherwise I think this looks great and is good to go! Thanks for your amazing work here and sorry for my long time in reviewing!

Co-authored-by: Lauren Adams <48136858+laurenliz22@users.noreply.github.com>
@JieXiong9119
Copy link
Copy Markdown
Contributor Author

Hey Jie - saw that "isn't" was changed to "isn"t'. Don't think this was in more than one place, but I can also not view the Level 2 audit for some reason (diff isn't loading). Can you just make sure? Otherwise I think this looks great and is good to go! Thanks for your amazing work here and sorry for my long time in reviewing!

Good catch! I modified that and will merge it.

@JieXiong9119 JieXiong9119 merged commit 20a0c46 into develop-v2 Aug 5, 2022
@JieXiong9119 JieXiong9119 deleted the update-notebooks-quotes branch August 5, 2022 18:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Non-breaking Change Schema: No Changes No updates to the BuildingSync Schema

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants