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

YAML documentation and JSON documentation fixes #141

Merged
merged 13 commits into from May 15, 2022
Merged

Conversation

CatalinStratu
Copy link
Contributor

@CatalinStratu CatalinStratu commented May 4, 2022

Hello, in this PR I added the example of using the YAML component and small fixes to the example of using the JSON component. Thank you!

@CatalinStratu
Copy link
Contributor Author

I'd like to hear from @ianling and @swinslow what they think of the changes I've made.

args := os.Args
if len(args) != 3 {
fmt.Printf("Usage: %v <yaml-file-in> <spdx-file-out>\n", args[0])
fmt.Printf(" Load SPDX 2.2 tag-value file <yaml-file-in>, and\n")
Copy link
Collaborator

Choose a reason for hiding this comment

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

Typo, loads a YAML file

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, I changed

defer w.Close()

// try to save the document to disk as an SPDX tag-value file, version 2.2
err = spdx_yaml.Save2_2(doc, w)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Saves a YAML file, not tag-value

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, I changed

@ianling
Copy link
Collaborator

ianling commented May 4, 2022

There might be more small nitpicky typos, I didn't seek them all out, but looks good 😃 thanks for adding examples

@CatalinStratu CatalinStratu requested a review from ianling May 5, 2022 05:55
swinslow and others added 12 commits May 5, 2022 09:38
Signed-off-by: Steve Winslow <steve@swinslow.net>
Signed-off-by: CatalinStratu <catalinstratu45@gmail.com>
Signed-off-by: Steve Winslow <steve@swinslow.net>
Signed-off-by: CatalinStratu <catalinstratu45@gmail.com>
Signed-off-by: Steve Winslow <steve@swinslow.net>
Signed-off-by: CatalinStratu <catalinstratu45@gmail.com>
Signed-off-by: Ian Ling <ian@iancaling.com>
Signed-off-by: CatalinStratu <catalinstratu45@gmail.com>
Signed-off-by: Ian Ling <ian@iancaling.com>
Signed-off-by: CatalinStratu <catalinstratu45@gmail.com>
Signed-off-by: CatalinStratu <catalinstratu45@gmail.com>
Signed-off-by: CatalinStratu <catalinstratu45@gmail.com>
Signed-off-by: CatalinStratu <catalinstratu45@gmail.com>
Signed-off-by: CatalinStratu <catalinstratu45@gmail.com>
Signed-off-by: CatalinStratu <catalinstratu45@gmail.com>
Signed-off-by: CatalinStratu <catalinstratu45@gmail.com>
Signed-off-by: CatalinStratu <catalinstratu45@gmail.com>
@CatalinStratu
Copy link
Contributor Author

Hi, @swinslow what do you think about this PR?

Copy link
Member

@swinslow swinslow left a comment

Choose a reason for hiding this comment

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

LGTM, thank you @CatalinStratu!

@swinslow swinslow merged commit a532726 into spdx:main May 15, 2022
@swinslow swinslow added this to the 0.4.0 milestone Jul 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants