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.

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

Tooling doc updates #1211

Merged
merged 5 commits into from
Dec 11, 2023
Merged

Tooling doc updates #1211

merged 5 commits into from
Dec 11, 2023

Conversation

cstirdivant
Copy link
Collaborator

Typo fixes and minor edits

Typo fixes and minor edits
Added ToC, minor edits
Updates to improve readability, added ToC
@cstirdivant cstirdivant changed the title Update README.md Tooling doc updates Dec 4, 2023
@cstirdivant cstirdivant requested a review from trav3711 December 4, 2023 23:11
@cstirdivant cstirdivant marked this pull request as ready for review December 4, 2023 23:12
Copy link
Contributor

@trav3711 trav3711 left a comment

Choose a reason for hiding this comment

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

two small nits.


#### Warnings
The following entity block would throw an error because it does not contain a type or a code.
```yaml
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: remove "yaml"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

including yaml formats the code block as if it were yaml text

type: HVAC/VAV_SD_CSP

The following entity block would only expose a warning because these are not the correct fields for VAV_SD_DSP as defined in DBO.
```yaml
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: remove "yaml"

@cstirdivant cstirdivant merged commit 81e7169 into master Dec 11, 2023
7 checks passed
@cstirdivant cstirdivant deleted the cstirdivant-tool-doc-updates branch December 11, 2023 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants