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

497-improve-xml-documentation #563

Merged
merged 4 commits into from
Oct 17, 2024
Merged

Conversation

TobiasNx
Copy link
Contributor

@TobiasNx TobiasNx commented Oct 9, 2024

Resolves #497

We decided to improve the documentation.

@TobiasNx TobiasNx requested a review from dr0i October 9, 2024 13:57
Copy link
Member

@dr0i dr0i left a comment

Choose a reason for hiding this comment

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

See suggestions.

@dr0i dr0i assigned TobiasNx and unassigned dr0i Oct 10, 2024
@blackwinter
Copy link
Member

There's no space between text chunks (+).

@TobiasNx
Copy link
Contributor Author

@TobiasNx TobiasNx assigned blackwinter and unassigned TobiasNx Oct 17, 2024
@blackwinter
Copy link
Member

You're concatenating strings without adding any whitespace between them. "a" + "b" yields "ab", you want "a " + "b" instead.

You chose unfortunate examples, here's a better one.

@blackwinter blackwinter assigned TobiasNx and unassigned blackwinter Oct 17, 2024
By @dr0i

Co-authored-by: Pascal Christoph <christoph@hbz-nrw.de>
@TobiasNx
Copy link
Contributor Author

Thanks done!

@TobiasNx TobiasNx requested a review from blackwinter October 17, 2024 10:36
Copy link
Member

@blackwinter blackwinter left a comment

Choose a reason for hiding this comment

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

For future reference: You can inspect the resulting documentation with ./gradlew fluxCommands.

@dr0i dr0i merged commit 71c367c into master Oct 17, 2024
1 check passed
@dr0i dr0i deleted the 497-improve-decode-xml-documentation branch October 17, 2024 14:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Log a hint if handle-generic-xml doesn't find a record so that the user knows to configure "recordtagname"
3 participants