Skip to content

docs: format go get command in code block#1554

Merged
nlopes merged 1 commit into
slack-go:masterfrom
akhil-ge0rge:docs/clarify-go-get-command
May 24, 2026
Merged

docs: format go get command in code block#1554
nlopes merged 1 commit into
slack-go:masterfrom
akhil-ge0rge:docs/clarify-go-get-command

Conversation

@akhil-ge0rge

Copy link
Copy Markdown
Contributor

Summary

Format the go get installation command in the README using a fenced Markdown code block.

The previous installation example included the shell prompt ($), which may lead users to copy it directly into the terminal and encounter errors such as command not found: $.

This change updates the installation section to display only the executable command inside a fenced bash code block for better readability and easier copy-paste.

Changes

  • Replace indented command formatting with a fenced Markdown code block
  • Remove the $ shell prompt from the installation example
  • Improve installation instructions readability

Before

## Installing

### *go get*

    $ go get -u github.com/slack-go/slack

After

## Installing

### *go get*

```bash
go get -u github.com/slack-go/slack

## Validation
- [x] Documentation change only
- [x] No API changes
- [ ] Run `make pr-prep`

Format the go get command in a code block
@nlopes nlopes self-assigned this May 24, 2026
@nlopes nlopes self-requested a review May 24, 2026 10:59

@nlopes nlopes left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For next time, I suggest a much shorter description, there's no need for such a comprehensive overview on such a simple change.

@nlopes nlopes merged commit ff3ada6 into slack-go:master May 24, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants