Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-54438

Documentation is not generating for wait parameter in build job

    XMLWordPrintable

Details

    Description

      On this page https://jenkins.io/doc/pipeline/steps/pipeline-build-step/ , the wait parameter doesn't have documentation of what it does.  From my understanding, it appears that the documentation should be generated from here https://github.com/jenkinsci/pipeline-build-step-plugin/blob/19f0118c04a0e68773e7dd6c89796605d5492bdc/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/build/BuildTriggerStep/help-wait.groovy .  

      I am not sure if there is a reason why this uses groovy to generate the HTML rather than HTML like the other documentation.  It appears to not be working in the way it is intended though.   

      Attachments

        Activity

          jglick Jesse Glick added a comment -

          The documentation generator only supports literal HTML, whereas this is using dynamically generated content.

          jglick Jesse Glick added a comment - The documentation generator only supports literal HTML, whereas this is using dynamically generated content.

          People

            Unassigned Unassigned
            c1505 corey morris
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated: