Better document lib.hudson.widget-refresh

[daniel-beck]

This is also used outside core, making it essentially API, so deserves to be documented. While I'm here, address some IDE complaints about my JS.

Testing done

None

Proposed changelog entries

• human-readable text

Proposed upgrade guidelines

N/A

Submitter checklist

Preview Give feedback

1. The Jira issue, if it exists, is well-described.
2. The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see examples). Fill in the Proposed upgrade guidelines section only if there are breaking changes or changes that may require extra steps from users during upgrade.
3. There is automated testing or an explanation as to why this change has no tests.
4. New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
5. New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
6. New or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives (see documentation).
7. For dependency updates, there are links to external changelogs and, if possible, full differentials.
8. For new APIs and extension points, there is a link to at least one consumer.

Desired reviewers

@mention

Before the changes are marked as ready-for-merge:

Maintainer checklist

Preview Give feedback

1. There are at least two (2) approvals for the pull request and no outstanding requests for change.
2. Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
3. Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
4. Proper changelog labels are set so that the changelog can be generated automatically.
5. If the change needs additional upgrade steps from users, the upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the pull request title (see example).
6. If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).

[fayazkhan121]

Switching from var to let improves code safety

[krisstern]

I don't think that extra change would suit the scope for this PR.

[daniel-beck]

This PR changes from var to let already, so I'm interpreting this comment as a confirmation of the change.

[krisstern]

Ah, I see! Thanks for clarifying.

[A1exKH]

@daniel-beck please, resolve comments in this PR.

[daniel-beck]

@A1exKH Please clarify which comments need resolving.

[krisstern]

There seem to be some issues need to be resolved in this PR. For example, there are 2 linting bugs reported at https://github.com/jenkinsci/jenkins/pull/10237/checks?check_run_id=36656792200.

[daniel-beck]

There seem to be some issues need to be resolved in this PR. For example, there are 2 linting bugs reported at https://github.com/jenkinsci/jenkins/pull/10237/checks?check_run_id=36656792200.

Thanks, I missed that. Seems weird that IntelliJ is not picking up on these declarations and/or that we do not allow this to compensate for poor IDE behavior, but especially the latter seems like a topic for another time.

[A1exKH]

@daniel-beck LGTM.

[krisstern]

/label ready-for-merge

This PR is now ready for merge, after ~24 hours, we will merge it if there's no negative feedback.