Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[JENKINS-9346] - Fix token macro help formatting #929

Merged
merged 1 commit into from
Jul 11, 2020
Merged

[JENKINS-9346] - Fix token macro help formatting #929

merged 1 commit into from
Jul 11, 2020

Conversation

MarkEWaite
Copy link
Contributor

@MarkEWaite MarkEWaite commented Jul 11, 2020 •
edited
Loading

JENKINS-9346 - Fix token macro help formatting

Git plugin token macro help formatting was using an unnecessary heading to prefix the description of token macro parameters. Other plugins use a definition list to describe the token macro parameters without the unnecessary heading. Do the same for the git plugin.

Checklist

  • I have read the CONTRIBUTING doc
  • I have referenced the Jira issue related to my changes in one or more commit messages
  • Unit tests pass locally with my changes
  • I have added documentation as necessary
  • No Javadoc warnings were introduced with my changes
  • No spotbugs warnings were introduced with my changes
  • Documentation in README has been updated as necessary
  • Online help has been added and reviewed for any new or modified fields
  • I have interactively tested my changes
  • Any dependent changes have been merged and published in upstream modules (like git-client-plugin)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)

Before the Fix

Annotation 2020-07-11 164319

After the Fix

screencapture-localhost-9090-jenkins-job-git-help-job-configure-2020-07-11-16_47_02-edit

@MarkEWaite
[JENKINS-9346] - Fix token macro help formatting
c13b646 
https://issues.jenkins-ci.org/browse/JENKINS-9346 reports that the
git plugin token macro help formatting is incorrect.

It was using an unnecessary heading to prefix the description of token
macro parameters.  Other plugins use a definition list to describe the
token macro parameters without the unnecessary heading.  Do the same
for the git plugin.
@MarkEWaite MarkEWaite merged commit 40dd071 into jenkinsci:master Jul 11, 2020
@MarkEWaite MarkEWaite added bugfix Fixes a bug - used by Release Drafter documentation Improvements or additions to documentation and removed bugfix Fixes a bug - used by Release Drafter labels Jul 11, 2020
@MarkEWaite MarkEWaite deleted the fix-help-formatting branch July 11, 2020 23:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@MarkEWaite