diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-06-25 00:08:15 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-06-25 00:08:15 +0300 |
commit | e09931576b593dc86fa40402929cc7b2990aa3e3 (patch) | |
tree | f54ae9d693e5a3fc517c52dc11ab636702ae425b /app/assets/javascripts/helpers | |
parent | 466b5db13b3c733ab0435f0c49ceac348b5284da (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'app/assets/javascripts/helpers')
-rw-r--r-- | app/assets/javascripts/helpers/help_page_helper.js | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/app/assets/javascripts/helpers/help_page_helper.js b/app/assets/javascripts/helpers/help_page_helper.js index 0e824548646..21d27b5fea9 100644 --- a/app/assets/javascripts/helpers/help_page_helper.js +++ b/app/assets/javascripts/helpers/help_page_helper.js @@ -7,9 +7,10 @@ const HELP_PAGE_URL_ROOT = '/help/'; * * This is designed to mirror the Ruby `help_page_path` helper function, so that * the two can be used interchangeably. - * @param {String} path - Path to doc file relative to the doc/ directory in the GitLab repository. - * Optionally, including `.md` or `.html` prefix - * @param {String} options.anchor - Name of the anchor to scroll to on the documentation page. + * @param {string} path - Path to doc file relative to the doc/ directory in the GitLab repository. + * Optionally, including `.md` or `.html` prefix + * @param {object} [options] + * @param {string} [options.anchor] - Name of the anchor to scroll to on the documentation page. */ export const helpPagePath = (path, { anchor = '' } = {}) => { let helpPath = joinPaths(gon.relative_url_root || '/', HELP_PAGE_URL_ROOT, path); |