This repository was archived by the owner on Sep 11, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 530
This repository was archived by the owner on Sep 11, 2020. It is now read-only.
doc improvements at package Plumbing #242
Copy link
Copy link
Closed
Description
- Difftree package: document.
- Format:
- Config:
- Document
Comment - Document
Config- Document undocumented methods
- Document
Include(reword) - Document
Options:- Fix format for
Getmethod.
- Fix format for
- Document
Sectionand its methods. - Document
Subsectionand its methods.
- Document
-
idxfile:- Reword
Decoder.Decodegiven multiple uses ofidxto refer to different things. Same forEncoder.Encode. - Document
EntryListmethods - Document
Idxfile.Addmethods
- Reword
- Document
index:- Document
ResolveUndoin a way it makes sense to have the name of the type at the beginning.
- Document
- Document
objfile:- Document package.
- Document
packfile:- Reword
GetDelta - Clarify
DecodeObjectAt. Why if offsets are a map from hashes to ints I am required to set them before reading something using an int? -
NewEncoderdoes no document what the third argument is for.
- Reword
- Package
pktline:- In
Encodef, what is thearguments suggests?
- In
- Config:
- Object
- Reword
WalkCommitHistory. Specify what it does, what the inputs are for, what happens if the callback returns an error, etc. - Document
DecodeBlob. -
NewBlobIterfix arguments explanation - Document
Commitfields. - In
NewObjectIter, rephrase input. - In
Signature, what is the field that holds the action that this type represents.
- Reword
- Package
protocol- Capabilities:
- Document package
- Capabilities:
- Package
revlist:- Documentation says that package implements functions in plural. Only one can be found.
- Package
storer:-
ReferenceStorertype doc update so it reads naturally. -
ShallowStorertype doc update so it reads naturally.
-
- Package
transport:- Package
client:- Document package.
- Package
file:- Document package.
- Package
git:- Document package.
- Package
ssh:- Document package.
- Package
Reactions are currently unavailable