feat: Minor cleanup of docs and trait defs. #112
Merged
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 commit marks the contents of the HashAlgorithm and ObjectType traits as hidden, because their internals are _only_ relevant to the internals of `GitOid`. The trait is sealed, so it can't be implemented by other types, and the types that _do_ implement it aren't able to be constructed (no public constructor + private field). This also moves all exported items to the top level, so there are no public submodules. The API of the crate is quite small, so it's nice for users to have all the docs accessible from one place. Signed-off-by: Andrew Lilley Brinker <[email protected]>
alilleybrinker
force-pushed
the
alilleybrinker/minor-fixups
branch
from
09ca365 to
68aeff8
Compare
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 commit marks the contents of the HashAlgorithm and ObjectType
traits as hidden, because their internals are only relevant to the
internals of
GitOid. The trait is sealed, so it can't be implementedby other types, and the types that do implement it aren't able to be
constructed (no public constructor + private field).
This also moves all exported items to the top level, so there are no
public submodules. The API of the crate is quite small, so it's nice
for users to have all the docs accessible from one place.
Signed-off-by: Andrew Lilley Brinker [email protected]
Description
Related Issue
Motivation and Context
How Has This Been Tested?