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

Fix Semgrep schema doc #1377

Merged
merged 2 commits into from
Nov 6, 2024
Merged

Fix Semgrep schema doc #1377

merged 2 commits into from
Nov 6, 2024

Conversation

hanzo
Copy link
Contributor

@hanzo hanzo commented Nov 5, 2024

Summary

Small followup to #1368, noticed that the schema doc is not being rendered correctly:

image

I'm not sure how to test that it will render correctly after this change, but this format matches the existing format used by the github schema:

#### Relationships
- Software on Github repos can import Python libraries by optionally specifying a version number.
```
(GitHubRepository)-[:REQUIRES{specifier}]->(PythonLibrary)
```
- specifier: A string describing this library's version e.g. "<4.0,>=3.0" or "==1.0.2". This field is only present on the `:REQUIRES` edge if the repo's requirements file provided a version pin.

hanzo added 2 commits November 5, 2024 14:47
Signed-off-by: Hans Wernetti <[email protected]>
Signed-off-by: Hans Wernetti <[email protected]>
@achantavy achantavy merged commit bf8d667 into master Nov 6, 2024
5 checks passed
@achantavy achantavy deleted the fix-doc branch November 6, 2024 00:05
chandanchowdhury pushed a commit to chandanchowdhury/cartography that referenced this pull request Nov 27, 2024
### Summary

Small followup to
cartography-cncf#1368, noticed that
the schema doc is not being rendered correctly:

![image](https://github.com/user-attachments/assets/e3f34e94-a7c0-4b39-b243-460fe39acb57)

I'm not sure how to test that it will render correctly after this
change, but this format matches the existing format used by the github
schema:

https://github.com/cartography-cncf/cartography/blob/f11d7b2ff87331ed736a5de2547cde812face1a0/docs/root/modules/github/schema.md?plain=1#L210-L218

---------

Signed-off-by: Hans Wernetti <[email protected]>
Signed-off-by: chandanchowdhury <[email protected]>
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