Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add documentation around catalogers, UI elements, and the event bus #143

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
Merged
merged 3 commits into from
Aug 12, 2020
Merged

Add documentation around catalogers, UI elements, and the event bus #143

merged 3 commits into from
Aug 12, 2020

Conversation

@wagoodman
Copy link
Contributor

@wagoodman wagoodman commented Aug 11, 2020 •
edited
Loading

  • Adds godoc comments to describe high level functionality around catalogers, UI elements, and the event bus
  • Adds terse descriptions for low-level functions
  • Refactors cataloging to eliminate the singleton

alfredodeza
alfredodeza reviewed Aug 11, 2020
View reviewed changes
@wagoodman wagoodman force-pushed the start-documenting-catalogers branch from 4df39c2 to cc6f85c Compare August 12, 2020 13:12
@wagoodman wagoodman changed the title Add basic documentation for catalogers Add documentation around catalogers, UI elements, and the event bus Aug 12, 2020
@wagoodman wagoodman marked this pull request as ready for review August 12, 2020 13:12
luhring
luhring approved these changes Aug 12, 2020
View reviewed changes
Copy link
Contributor

@luhring luhring left a comment

Choose a reason for hiding this comment

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

This is great work. The doc comments are super helpful to have. It also helps others start to wrap their heads around ideas for potential refactors.

@wagoodman
update bus phrasing
7b0e839 
Signed-off-by: Alex Goodman <[email protected]>
@wagoodman wagoodman merged commit 51b9c73 into main Aug 12, 2020
@wagoodman wagoodman deleted the start-documenting-catalogers branch August 12, 2020 15:04
This was referenced Sep 15, 2021
Open
Open
@snyk-bot snyk-bot mentioned this pull request Sep 27, 2021
Open
@ekmixon ekmixon mentioned this pull request Nov 30, 2023
Open
@ddzzj ddzzj mentioned this pull request Dec 1, 2023
Open
@stnert stnert mentioned this pull request Dec 1, 2023
Open
GijsCalis pushed a commit to GijsCalis/syft that referenced this pull request Feb 19, 2024
@wagoodman
Add documentation around catalogers, UI elements, and the event bus (a…
587b997 
…nchore#143)

* add basic documentation for catalogers (with refactoring for simplification)

Signed-off-by: Alex Goodman <[email protected]>

* add docs for catalog parsers, UI, and event bus

Signed-off-by: Alex Goodman <[email protected]>

* update bus phrasing

Signed-off-by: Alex Goodman <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@alfredodeza alfredodeza alfredodeza approved these changes

@luhring luhring luhring approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@wagoodman @alfredodeza @luhring