Upgrade function documentation

Open Beginner friendly
#81 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
go
Domain
documentation

Research direction

Start at the Upgrade function documentation in the Go project and read the function behavior it describes. Update the description to explain that Upgrade waits for the response and returns an error when the child process fails. Done means the documentation accurately reflects this synchronous behavior and failure result.

Written by the indexing model from the issue text.

Description

The Upgrade function is documented as:

Upgrade triggers an upgrade.

It also waits for response and returns error if child process fails, which might be good to spell out in the description since the verb 'trigger' gives an impression of a function call that will complete immediately

Dominant language
Go
Stars
3.2k
Forks
158
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from cloudflare/tableflip

All issues in cloudflare/tableflip

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.