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

Doc fix #383

Merged
merged 2 commits into from
Feb 21, 2024
Merged

Conversation

oyvindronningstad
Copy link
Collaborator

No description provided.

ARCHITECTURE.md Outdated
@@ -117,20 +117,15 @@ This class relies heavily on decoding libraries for CBOR/YAML/JSON:

All three use the same internal representation of the decoded data, so it's trivial to convert between them.
The representation for all three is 1-to-1 with the corresponding Python types, (list -> list, map -> dict, uint -> int, bstr -> bytes etc.).
The only proprietary Python class used is `CBORTag` for CBOR tags.
The only proprietary Python classes used is `cbor2.CBORTag` for CBOR tags, `cbor2.undefined` for CBOR `undefined` values, and `cbor2.CBORSimpleValue` for CBOR simple values (#7.0 -> #7.255 excluding bools, nil, and undefined).
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: "classes used are"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks, fixed

ARCHITECTURE.md Outdated
@@ -173,11 +168,12 @@ CodeRenderer
------------

CodeRenderer is a standalone class that takes the result of the CodeGenerator class and constructs files.
There are 3 files constructed:
There are 4 files constructed:

Choose a reason for hiding this comment

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

Up to ? as if you don't opt into the optional cmake file?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks, added "up to"

@oyvindronningstad oyvindronningstad merged commit b0302cf into NordicSemiconductor:main Feb 21, 2024
17 checks passed
@oyvindronningstad oyvindronningstad deleted the doc-fix branch February 21, 2024 10:35
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.

3 participants