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

upadat example in javadoc for EMBEDDED_EXPRESSION* tokens #14317

Closed
romani opened this issue Jan 20, 2024 · 7 comments · Fixed by #14512
Closed

upadat example in javadoc for EMBEDDED_EXPRESSION* tokens #14317

romani opened this issue Jan 20, 2024 · 7 comments · Fixed by #14512

Comments

@romani
Copy link
Member

romani commented Jan 20, 2024

from #13991 (comment)

Update examples for:
EMBEDDED_EXPRESSION_BEGIN
EMBEDDED_EXPRESSION
EMBEDDED_EXPRESSION_END

from
String s = STR."Hello, \{getName(firstName, lastName)}!";
to
String s = STR."Hello, \{getName("Mr. ", firstName, lastName)}!";

Reason: to show how " are rendered in tree in STR."

@ViswanathBalla22
Copy link

ViswanathBalla22 commented Jan 21, 2024

Hello @romani,

I hope you're doing well! I'm a beginner eager to contribute and I came across issue #14317 about updating examples for EMBEDDED_EXPRESSION* tokens in Javadoc.

This seems like a great opportunity for me to learn and make my first contribution. I'd love to take on this task and would appreciate any guidance or advice you can provide. If you're open to it, I'm ready to dive in and work on this.

Looking forward to your support and getting started on my first contribution.

@ViswanathBalla22
Copy link

Hi @romani,

I hope this message finds you well. I'm currently working on issue #14317 regarding the update to examples for EMBEDDED_EXPRESSION_BEGIN, EMBEDDED_EXPRESSION, and EMBEDDED_EXPRESSION_END tokens in the Javadoc.

I noticed that the examples provided in the issue seem to be the same:

Original:

from-
String s = STR."Hello, {getName("Mr. ", firstName, lastName)}!";
to(same as original):
String s = STR."Hello, {getName("Mr. ", firstName, lastName)}!";
Could you please provide additional details or clarify the expected changes? I want to make sure I address the issue correctly.

@romani
Copy link
Member Author

romani commented Jan 21, 2024

Issue description is updated, that for pointing to problem.

Tre can be build by https://checkstyle.org/cmdline.html#Command_line_usage
"-t" parameters.
As fix for new tokens is not released , please build all jar file by https://github.com/checkstyle/checkstyle/wiki/How-to-run-certain-phases-and-validations#how-to-generate-all-binaries-and--alljar--too

@ViswanathBalla22
Copy link

ViswanathBalla22 commented Jan 21, 2024

Hi @romani ,

I'm interested in working on this issue (#14317) regarding the update to examples for EMBEDDED_EXPRESSION_BEGIN, EMBEDDED_EXPRESSION, and EMBEDDED_EXPRESSION_END tokens in the Javadoc.

Approch :-
I plan to update the examples to demonstrate how double quotes are rendered in the tree for STR. Specifically, I'll modify the code from:

String s = STR."Hello, {getName(firstName, lastName)}!";
to:

String s = STR."Hello, {getName("Mr. ", firstName, lastName)}!";
is this way approch is to solve this or any other task in this issue .

@nrmancuso
Copy link
Member

@ViswanathBalla22 please send a pull request with your proposed changes, and we can go from there

@mahfouz72
Copy link
Contributor

I am on it

@nrmancuso
Copy link
Member

Closed via #14512

@github-actions github-actions bot added this to the 10.14.0 milestone Feb 21, 2024
kalpadiptyaroy pushed a commit to kalpadiptyaroy/checkstyle that referenced this issue Feb 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants