Skip to content

Commit

Permalink
Replace godoc.org URLs (#342)
Browse files Browse the repository at this point in the history
* Replaced godoc.org URLs with equivalent pkg.go.dev URLs.

* Switched to full package name for github.com/magefile/mage/mg.

Co-authored-by: Aaron Schlesinger <70865+arschles@users.noreply.github.com>

Co-authored-by: Aaron Schlesinger <70865+arschles@users.noreply.github.com>
  • Loading branch information
JamieEdge and arschles committed Jan 16, 2022
1 parent c07f313 commit 526bf47
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 10 deletions.
5 changes: 3 additions & 2 deletions README.md
Expand Up @@ -53,9 +53,10 @@ for discussion of usage, development, etc.

# Documentation

see [magefile.org](https://magefile.org) for full docs
See [magefile.org](https://magefile.org) for full documentation.

see [godoc.org/github.com/magefile/mage/mage](https://godoc.org/github.com/magefile/mage/mage) for how to use mage as a library.
See [pkg.go.dev/github.com/magefile/mage/mage](https://pkg.go.dev/github.com/magefile/mage/mage)
for instructions on how to use Mage as a library.

# Why?

Expand Down
4 changes: 2 additions & 2 deletions site/content/dependencies/_index.en.md
Expand Up @@ -4,8 +4,8 @@ weight = 30
+++

Mage supports a makefile-style tree of dependencies using the helper library
[github.com/magefile/mage/mg](https://godoc.org/github.com/magefile/mage/mg). To
declare dependencies, pass any number of dependent functions to mg.Deps.
[github.com/magefile/mage/mg](https://pkg.go.dev/github.com/magefile/mage/mg). To declare dependencies,
pass any number of dependent functions to mg.Deps.

A dependent function may be any function that has an optional first argument of context.Context, has
either no return or just an error return, and where the other arguments are all of type string, int,
Expand Down
2 changes: 1 addition & 1 deletion site/content/filesources/_index.en.md
Expand Up @@ -4,7 +4,7 @@ weight = 35
+++

Mage supports make-like comparisons of file sources and file targets. Using the
[target](https://godoc.org/github.com/magefile/mage/target) library, you can
[target](https://pkg.go.dev/github.com/magefile/mage/target) library, you can
easily compare the last modified times of a target file or directory with the
last modified time of the file or directories required to build that target.

Expand Down
6 changes: 3 additions & 3 deletions site/content/libraries/_index.en.md
Expand Up @@ -4,9 +4,9 @@ weight = 45
+++

There are three helper libraries bundled with mage,
[mg](https://godoc.org/github.com/magefile/mage/mg),
[sh](https://godoc.org/github.com/magefile/mage/sh), and
[target](https://godoc.org/github.com/magefile/mage/target)
[mg](https://pkg.go.dev/github.com/magefile/mage/mg),
[sh](https://pkg.go.dev/github.com/magefile/mage/sh) and
[target](https://pkg.go.dev/github.com/magefile/mage/target).

Package `mg` contains mage-specific helpers, such as Deps for declaring
dependent functions, and functions for returning errors with specific error
Expand Down
4 changes: 2 additions & 2 deletions site/content/zeroInstall/_index.en.md
Expand Up @@ -44,8 +44,8 @@ required = ["github.com/magefile/mage/mage"]

## Use Mage as a library

All of mage's functionality is accessible as a compile-in library. Checkout
[godoc.org/github.com/magefile/mage/mage](https://godoc.org/github.com/magefile/mage/mage)
All of mage's functionality is accessible as a compile-in library. Check out
[pkg.go.dev/github.com/magefile/mage/mage](https://pkg.go.dev/github.com/magefile/mage/mage)
for full details.

Fair warning, the API of mage/mage may change, so be sure to use vendoring.
Expand Down

0 comments on commit 526bf47

Please sign in to comment.