Skip to content

chore: improve code comments clarity #354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xiaolinny wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: improve code comments clarity #354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/provider-services/cmd/manifest.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ func doSendManifest(cmd *cobra.Command, sdlpath string) error {
return err
}

// the owner address in FlagFrom has already been validated thus save to just pull its value as string
// the owner address in FlagFrom has already been validated thus safe to just pull its value as string
leases, err := leasesForDeployment(ctx, cctx, cmd.Flags(), queryClientOrNil(cl))
if err != nil {
return markRPCServerError(err)
Expand Down
2 changes: 1 addition & 1 deletion gateway/rest/router.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ const (

const (
// as per RFC https://www.iana.org/assignments/websocket/websocket.xhtml#close-code-number
// errors from private use staring
// errors from private use starting
websocketInternalServerErrorCode = 4000
websocketLeaseNotFound = 4001
manifestSubmitTimeout = 120 * time.Second
Expand Down
2 changes: 1 addition & 1 deletion gateway/rest/router_migrate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ func migrateHandler(log log.Logger, hostnameService clustertypes.HostnameService
owner := requestOwner(req)

// Make sure this hostname can be taken
// make sure destination deployment actually exists
// make sure destination deployment actually exists
found, leaseID, mgroup, err := clusterService.FindActiveLease(req.Context(), owner, body.DestinationDSeq, body.DestinationGSeq)
if err != nil {
log.Error("failed checking if destination deployment exists", "err", err)
Expand Down
2 changes: 1 addition & 1 deletion gateway/rest/router_shell.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ func leaseShellWebsocketHandler(log log.Logger, wg *sync.WaitGroup, shellWs *web
case LeaseShellCodeTerminalResize:
var size remotecommand.TerminalSize
r := bytes.NewReader(msg)
// Unpack data, its just binary encoded data in big endian
// Unpack data, it's just binary encoded data in big endian
err = binary.Read(r, binary.BigEndian, &size.Width)
if err != nil {
return
Expand Down
8 changes: 4 additions & 4 deletions service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,16 +242,16 @@ func (s *service) Validate(ctx context.Context, owner sdktypes.Address, gspec dt

// inv, err := s.cclient.Inventory(ctx)
// if err != nil {
// return ValidateGroupSpecResult{}, err
// return ValidateGroupSpecResult{}, err
// }
//
// res := &reservation{
// resources: nil,
// clusterParams: nil,
// resources: nil,
// clusterParams: nil,
// }
//
// if err = inv.Adjust(res, ctypes.WithDryRun()); err != nil {
// return ValidateGroupSpecResult{}, err
// return ValidateGroupSpecResult{}, err
// }

price, err := s.config.BidPricingStrategy.CalculatePrice(ctx, req)
Expand Down