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

Adds README for code generation #178

Merged
merged 6 commits into from
Nov 5, 2024
Merged

Conversation

desaikd
Copy link
Contributor

@desaikd desaikd commented Nov 5, 2024

Issue #, if available:

Description of changes:

This PR creates a README for code generation.

List of changes:

  • Adds a README for code generation
  • Adds reference to README for code generation
  • Removes experimental feature related information from README

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@desaikd desaikd requested a review from popematt November 5, 2024 17:08
Copy link
Contributor

@popematt popematt left a comment

Choose a reason for hiding this comment

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

Looking good. There's only maybe two comments that affect the content of the document. The rest of them are formatting and grammar suggestions (mostly adding syntax highlighting to the code blocks)

src/bin/ion/commands/generate/README.md Outdated Show resolved Hide resolved
src/bin/ion/commands/generate/README.md Outdated Show resolved Hide resolved
src/bin/ion/commands/generate/README.md Outdated Show resolved Hide resolved
src/bin/ion/commands/generate/README.md Outdated Show resolved Hide resolved
src/bin/ion/commands/generate/README.md Outdated Show resolved Hide resolved
src/bin/ion/commands/generate/README.md Outdated Show resolved Hide resolved
src/bin/ion/commands/generate/README.md Outdated Show resolved Hide resolved
src/bin/ion/commands/generate/README.md Outdated Show resolved Hide resolved
src/bin/ion/commands/generate/README.md Outdated Show resolved Hide resolved
src/bin/ion/commands/generate/README.md Outdated Show resolved Hide resolved
Comment on lines 347 to 349
let mut reader: Reader = ReaderBuilder::new().build(ION_DATA) ?;
reader.next() ?;
let foo: Foo = Foo::read_from( & mut reader) ?;
Copy link
Contributor

Choose a reason for hiding this comment

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

Any particular reason for the added spaces here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

huh. I removed those spaces. I think its getting formatted because I added rust syntax highlighting and this code block does not really contain a main. I will just remove the highlight I think.

@desaikd desaikd merged commit 5b292fa into amazon-ion:main Nov 5, 2024
3 checks passed
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