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

Add tutorial for symbol and string collection using /api/collect endpoint #411

Merged
merged 9 commits into from
May 10, 2024

Conversation

keshav-space
Copy link
Member

Signed-off-by: Keshav Priyadarshi <git@keshav.space>
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
Copy link
Member

@JonoYang JonoYang left a comment

Choose a reason for hiding this comment

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

@keshav-space Instructions are clear, I left some comments about some of the examples not having data in the extra_data field.

Signed-off-by: Keshav Priyadarshi <git@keshav.space>
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
Copy link
Member

@JonoYang JonoYang left a comment

Choose a reason for hiding this comment

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

@keshav-space Thanks for updating the example to include more results, but I think some of the results can be truncated so the doc page isnt so large with example data. Other than that, I think it looks good.

Signed-off-by: Keshav Priyadarshi <git@keshav.space>
@keshav-space
Copy link
Member Author

keshav-space commented May 8, 2024

but I think some of the results can be truncated so the doc page isnt so large with example data

@JonoYang I tried using ellipsis to truncate the JSON result, but that resulted in Sphinx throwing lexing error. Instead of truncating the results, I have changed the example to a smaller file, and we still have sufficient results to show from each tools.

@pombredanne
Copy link
Member

@JonoYang we found a way using the standard HTML <details> tag to collapse/expand long text runs

@keshav-space keshav-space marked this pull request as draft May 8, 2024 14:54
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
Reference: aboutcode-org/scancode.io#1220

Signed-off-by: Keshav Priyadarshi <git@keshav.space>
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
@keshav-space keshav-space marked this pull request as ready for review May 9, 2024 10:56
@keshav-space
Copy link
Member Author

@JonoYang

RTD.Tutorial.mov

@keshav-space keshav-space requested a review from JonoYang May 9, 2024 13:22
@JonoYang
Copy link
Member

@keshav-space The toggle-able file contents looks great, thanks!

@JonoYang JonoYang merged commit 972e714 into main May 10, 2024
8 checks passed
@JonoYang JonoYang deleted the symbol-string-docs branch May 10, 2024 00:03
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