Skip to content

doc/modules/gomod-ref: document the ignore directive#357

Open
abhay1999 wants to merge 1 commit intogolang:masterfrom
abhay1999:doc-gomod-ref-add-ignore
Open

doc/modules/gomod-ref: document the ignore directive#357
abhay1999 wants to merge 1 commit intogolang:masterfrom
abhay1999:doc-gomod-ref-add-ignore

Conversation

@abhay1999
Copy link
Copy Markdown

@abhay1999 abhay1999 commented Apr 3, 2026

The go.mod reference page at https://go.dev/doc/modules/gomod-ref was
missing the ignore directive, even though it is documented in the Go
Modules Reference at https://go.dev/ref/mod#go-mod-file-ignore.

This adds a full ignore section following the same structure as the
existing exclude and retract sections, with syntax, examples (relative
path, named directory, and block form), and usage notes. The intro
paragraph is also updated to mention ignore alongside replace and
exclude.

Fixes golang/go#78460

The go.mod reference page at /doc/modules/gomod-ref was missing the
ignore directive, even though it is documented in the Go Modules
Reference at /ref/mod#go-mod-file-ignore.

Add a full section for the ignore directive following the same
structure as the other directive sections (exclude, retract), with
syntax, examples, and notes. Also update the intro paragraph to
mention ignore alongside replace and exclude.

Fixes golang/go#78460

Signed-off-by: Abhay Chaurasiya <abhaychaurasiya19@gmail.com>
Signed-off-by: abhay1999 <abhaychaurasiya19@gmail.com>
@gopherbot
Copy link
Copy Markdown
Contributor

This PR (HEAD: eb5a1e2) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/website/+/762520.

Important tips:

  • Don't comment on this PR. All discussion takes place in Gerrit.
  • You need a Gmail or other Google account to log in to Gerrit.
  • To change your code in response to feedback:
    • Push a new commit to the branch used by your GitHub PR.
    • A new "patch set" will then appear in Gerrit.
    • Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
    • Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
    • Multiple commits in the PR will be squashed by GerritBot.
  • The title and description of the GitHub PR are used to construct the final commit message.
    • Edit these as needed via the GitHub web interface (not via Gerrit or git).
    • You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
  • See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

@gopherbot
Copy link
Copy Markdown
Contributor

Message from Gopher Robot:

Patch Set 1:

(1 comment)


Please don’t reply on this GitHub thread. Visit golang.org/cl/762520.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Copy Markdown
Contributor

Message from Abhay Chaurasiya:

Patch Set 1:

(1 comment)


Please don’t reply on this GitHub thread. Visit golang.org/cl/762520.
After addressing review feedback, remember to publish your drafts!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

x/website/_content/ref: go.mod's ignore directive is underdocumented

2 participants