Documentation: Add docs/annotation_process.md #87
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
This new documentation is linked from README.md, and should also be linked from the generated documentation at https://ncusi.github.io/PatchScope being available in 'usage' tab. TODO: "Computing commit and diff metadata" and "Output format" sections are currently missing, with only a placeholder for them present in new doc.
…s.md Replaces one of TODOs placeholders with a full description, borrowing from other docs/*.md files, and from docstrings in 'annotate.py' and in 'git.py'. While at it, fix miscalculation in docs/author_statistics.md.
|
Checks failed because of mismatched cache (somehow). |
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.
This new documentation, linked from README.md, and added to mkdocs.yml,
describes the annotation process, and computed metrics.