Skip to content

Commit

Permalink
Clean up docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
doriable committed May 16, 2024
1 parent 9aff322 commit 67b924f
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions private/pkg/git/git.go
Original file line number Diff line number Diff line change
Expand Up @@ -176,11 +176,17 @@ type Remote interface {
// repository path information.
//
// If the remote hostname contains bitbucket (e.g. bitbucket.mycompany.com or bitbucket.org),
// then it uses the route /commits for the git commit sha.
// we construct the source control URL as:
//
// If the remote hostname contains github (e.g. github.mycompany.com or github.com) or gitlab
// (e.g. gitlab.mycompany.com or gitlab.com) then it uses the route /commit for the git
// commit sha.
// https://<hostname>/<repository-path>/commits/<git-commit-sha>
//
// If the remote hostname contains github (e.g. github.mycompany.com or github.com), we
// construct the source control URL as:
// https://<hostname>/repository-path>/commit/git-commit-sha>
//
// If the remote hostname contains gitlab (e.g. gitlab.mycompany.com or gitlab.com), we
// construct the source control URL as:
// https://<hostname>/repository-path>/commit/git-commit-sha>
//
// If the remote is unknown and/or no hostname/repository path information is available,
// this will return an empty string.
Expand Down

0 comments on commit 67b924f

Please sign in to comment.