Update documentation and normalizes code comments for attribution #140
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Adds attrbution for adapted directed Graph and iterator implementation - Adds reference to NodeBudget adaptation Signed-off-by: Jennifer Power <[email protected]>
Removes out of data documentation under docs/design. Moves node information into a README.md under the nodes package and adds example usage snippets. Signed-off-by: Jennifer Power <[email protected]>
Updates attribution comments and add TODO comments Adds a defer statement to close io.ReadCloser types return when unused to avoid leaking resources. Signed-off-by: Jennifer Power <[email protected]>
jpower432
force-pushed
the
docs/design-docs-and-comments
branch
from
2b51c31 to
88cdd05
Compare
jpower432
changed the title
jpower432
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
PR to improve design documents and provide additional links and comments for adaptation/attribution and better understand of code design and sources of inspiration. This is part one to addressing #128.
Type of change
How Has This Been Tested?
Documentation and comment updates only.
Checklist: