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.

Sign up for GitHub

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

Jump to bottom

Improve documentation(s) #22

Open
pombredanne opened this issue Sep 10, 2022 · 2 comments
Open

Improve documentation(s) #22

pombredanne opened this issue Sep 10, 2022 · 2 comments

Comments

@pombredanne
Copy link
Member

pombredanne commented Sep 10, 2022 •
edited
Loading

The API-related documentation could be improved, and the overall overview is missing.
@pombredanne pombredanne changed the title Improve documentations Improve documentation(s) Sep 10, 2022
@pombredanne pombredanne mentioned this issue Sep 10, 2022
Merged
@pombredanne
Copy link
Member Author

I pushed #22 with a first pass.

pombredanne added a commit that referenced this issue Jan 16, 2023
@pombredanne
Merge pull request #23 from nexB/improve-help-and-doc
88c9010 
Improve help and doc #22
@AyanSinhaMahapatra
Copy link
Member

We also need a minimal CHANGELOG where we document updates to the licenseDB manually.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pombredanne @AyanSinhaMahapatra