Skip to content

Commit

Permalink
doc: minor textual corrections (#447)
Browse files Browse the repository at this point in the history
  • Loading branch information
criadoperez authored Oct 3, 2023
1 parent e3ca2ea commit 9a94e07
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions cmd/lassie/flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ var providerBlockList map[peer.ID]bool
var FlagExcludeProviders = &cli.StringFlag{
Name: "exclude-providers",
DefaultText: "All providers allowed",
Usage: "Provider peer IDs, seperated by a comma. Example: 12D3KooWBSTEYMLSu5FnQjshEVah9LFGEZoQt26eacCEVYfedWA4",
Usage: "Provider peer IDs, separated by a comma. Example: 12D3KooWBSTEYMLSu5FnQjshEVah9LFGEZoQt26eacCEVYfedWA4",
EnvVars: []string{"LASSIE_EXCLUDE_PROVIDERS"},
Action: func(cctx *cli.Context, v string) error {
// Do nothing if given an empty string
Expand Down Expand Up @@ -152,7 +152,7 @@ var protocols []multicodec.Code
var FlagProtocols = &cli.StringFlag{
Name: "protocols",
DefaultText: "bitswap,graphsync,http",
Usage: "List of retrieval protocols to use, seperated by a comma",
Usage: "List of retrieval protocols to use, separated by a comma",
EnvVars: []string{"LASSIE_SUPPORTED_PROTOCOLS"},
Action: func(cctx *cli.Context, v string) error {
// Do nothing if given an empty string
Expand Down
2 changes: 1 addition & 1 deletion docs/HTTP_SPEC.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ Something went wrong with the application.

### `504` Gateway Timeout

A timeout occured while retrieving the given CID.
A timeout occurred while retrieving the given CID.

## Response Headers

Expand Down
2 changes: 1 addition & 1 deletion pkg/aggregateeventrecorder/aggregateeventrecorder.go
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ type AggregateEvent struct {
TimeToFirstByte string `json:"timeToFirstByte,omitempty"` // The time it took to receive the first byte in milliseconds
Bandwidth uint64 `json:"bandwidth,omitempty"` // The bandwidth of the retrieval in bytes per second
BytesTransferred uint64 `json:"bytesTransferred,omitempty"` // The total transmitted deal size
Success bool `json:"success"` // Wether or not the retreival ended with a success event
Success bool `json:"success"` // Whether or not the retrieval ended with a success event
StartTime time.Time `json:"startTime"` // The time the retrieval started
EndTime time.Time `json:"endTime"` // The time the retrieval ended

Expand Down
2 changes: 1 addition & 1 deletion pkg/internal/itest/testpeer/generator.go
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ func NewTestHttpPeer(ctx context.Context, mn mocknet.Mocknet, p tnet.Identity, t
return TestPeer{}, err
}

// Create http multiaddr from random peer addr and add it to the peer's addreses
// Create http multiaddr from random peer addr and add it to the peer's addresses
httpAddr := p.Address().Encapsulate(ma.StringCast("/http"))
peer.Host.Peerstore().AddAddr(p.ID(), httpAddr, 10*time.Minute) // TODO: Look into ttl duration?

Expand Down
2 changes: 1 addition & 1 deletion pkg/retriever/bitswapretriever.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ type InProgressCids interface {
}

// BitswapRetriever uses bitswap to retrieve data
// BitswapRetriever retieves using a combination of a go-bitswap client specially configured per retrieval,
// BitswapRetriever retrieves using a combination of a go-bitswap client specially configured per retrieval,
// underneath a blockservice and a go-fetcher Fetcher.
// Selectors are used to travers the dag to make sure the CARs for bitswap match graphsync
// Note: this is a tradeoff over go-merkledag for traversal, cause selector execution is slow. But the solution
Expand Down
2 changes: 1 addition & 1 deletion pkg/types/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ type AsyncRetrievalTask struct {
AsyncCandidateRetrieval CandidateRetrieval
}

// Run executes the asychronous retrieval task
// Run executes the asynchronous retrieval task
func (art AsyncRetrievalTask) Run() (*RetrievalStats, error) {
return art.AsyncCandidateRetrieval.RetrieveFromAsyncCandidates(art.Candidates)
}
Expand Down

0 comments on commit 9a94e07

Please sign in to comment.