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.

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

Update progressiveText.jelly with documentation tag #10085

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

duemir
Copy link
Member

@duemir duemir commented Dec 20, 2024

The st:documentation and st:attribute tags are used by Jenkins Development Support plugin for autocomplete and documentation lookup.

I did this quick change in the GitHub editor as much as a conversation starter as the suggestion. There more instances like this, so there is likely more work required. Tags documented like this get a benefit of autocompletion and documentation and deprecated attribute validation from the IntelliJ plugin. The more tags are update with unsupported documentation format the less helpful IntelliJ plugin becomes.

See JENKINS-XXXXX.

Testing done

Proposed changelog entries

  • human-readable text

Proposed upgrade guidelines

N/A

Submitter checklist

Preview Give feedback

Desired reviewers

@mention

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

Maintainer checklist

Preview Give feedback

The `st:documentation` and `st:attribute` tags are used by Jenkins Development Support plugin for autocomplete and documentation lookup.
@duemir
Copy link
Member Author

duemir commented Dec 20, 2024

Sure, its flawed and needs to be fixed. But what about content? Does any tool rely on those JSP style comments? Or should I go forward and try and replace all of them with st:documentation/st:attribute?

@timja
Copy link
Member

timja commented Dec 20, 2024

Sure, its flawed and needs to be fixed. But what about content? Does any tool rely on those JSP style comments? Or should I go forward and try and replace all of them with st:documentation/st:attribute?

Not that I'm aware of, content looks good and yes good to use st:documentation etc everywhere

The comment was replaced with a documentation tag. A few gaps were filled to the best of my understanding.
@duemir
Copy link
Member Author

duemir commented Dec 21, 2024

It turned out there were only a few. I addressed the comments and updated the other two tags.

@duemir duemir requested review from timja and daniel-beck December 21, 2024 00:30
Copy link
Member

@timja timja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

I think Alex went through at some point and fixed most of this up.

@timja timja requested a review from a team December 22, 2024 22:41
@timja timja added the skip-changelog Should not be shown in the changelog label Dec 22, 2024
Copy link

@A1exKH A1exKH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@duemir this PR LGTM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog Should not be shown in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants