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 534
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
Get
method.
- Fix format for
- Document
Section
and its methods. - Document
Subsection
and its methods.
- Document
-
idxfile
:- Reword
Decoder.Decode
given multiple uses ofidx
to refer to different things. Same forEncoder.Encode
. - Document
EntryList
methods - Document
Idxfile.Add
methods
- Reword
- Document
index
:- Document
ResolveUndo
in 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? -
NewEncoder
does 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
. -
NewBlobIter
fix arguments explanation - Document
Commit
fields. - 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
:-
ReferenceStorer
type doc update so it reads naturally. -
ShallowStorer
type 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