Skip to content

Improve docs - #316

Merged
sbs2001 merged 6 commits into
mainfrom
improve-docs
Feb 13, 2021
Merged

Improve docs#316
sbs2001 merged 6 commits into
mainfrom
improve-docs

Conversation

@pombredanne

Copy link
Copy Markdown
Member

This PR refines the README documentation.

There are some dead 404 link and I am not sure who is behind this.
Let's not use it at all for now.

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
pombredanne requested a review from sbs2001 January 27, 2021 13:47

@sbs2001 sbs2001 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks ! This is better, please correct the typos I've highlighted, and we're good to merge this.

@pombredanne

Copy link
Copy Markdown
Member Author

Thanks ! This is better, please correct the typos I've highlighted, and we're good to merge this.

I could not see comments about typos, may be you did not submit your review yet and the comments are still pending the full review submissian?

@sbs2001
sbs2001 self-requested a review January 29, 2021 14:14
Comment thread README.rst Outdated

The packages are identified using Package URL `PURL
<https://github.com/package-url/purl-spec>`__ as primary identifiers rather than
CPEs. This makes packeg queries more dpscific and more accurate to answer

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This line contains 2 typos

@sbs2001

sbs2001 commented Jan 29, 2021

Copy link
Copy Markdown
Collaborator

@pombredanne I don't know what happened, anyways I've commented the line with typos

Signed-off-by: Shivam Sandbhor <shivam.sandbhor@gmail.com>
@sbs2001

sbs2001 commented Feb 13, 2021

Copy link
Copy Markdown
Collaborator

I commited typo fixes and merging this.

@sbs2001
sbs2001 merged commit 242ac17 into main Feb 13, 2021
@sbs2001
sbs2001 deleted the improve-docs branch February 13, 2021 05:25
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