admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

GithubLatest: Tweak documentation comments

Browse Source
This commit is contained in:
Sam Ford 2023-05-15 23:31:48 -04:00
parent db7a6baa33
commit 1dd7556c74
No known key found for this signature in database
GPG Key ID: 7AF5CBEE1DD6F76D
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Library/Homebrew/livecheck/strategy/github_latest.rb
View File

@ -16,14 +16,15 @@ module Homebrew
#
# {GithubLatest} should only be used when the upstream repository has a
# "latest" release for a suitable version and the strategy is necessary
# or appropriate (e.g. {Git} returns an unreleased version or the
# `stable` URL is a release asset). The strategy can only be applied by
# using `strategy :github_latest` in a `livecheck` block.
# or appropriate (e.g. the formula/cask uses a release asset or the
# {Git} strategy returns an unreleased version). The strategy can only
# be applied by using `strategy :github_latest` in a `livecheck` block.
#
# The default regex identifies versions like `1.2.3`/`v1.2.3` in the
# release's tag name. This is a common tag format but a modified regex
# can be provided in a `livecheck` block to override the default if a
# repository uses a different format (e.g. `1.2.3d`, `1.2.3-4`, etc.).
# The default regex identifies versions like `1.2.3`/`v1.2.3` in a
# release's tag or title. This is a common tag format but a modified
# regex can be provided in a `livecheck` block to override the default
# if a repository uses a different format (e.g. `1.2.3d`, `1.2.3-4`,
# etc.).
#
# @api public
class GithubLatest