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.

Sign up for GitHub

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

Jump to bottom

Consistently use template strings for XML snippets #128

Open
brodybits opened this issue Sep 18, 2020 · 6 comments
Open

Consistently use template strings for XML snippets #128

brodybits opened this issue Sep 18, 2020 · 6 comments
Assignees
@brodybits
Labels
code style documentation Improvements or additions to documentation good first issue Good for newcomers help-wanted External contributions welcome testing

Comments

@brodybits
Copy link
Member

brodybits commented Sep 18, 2020 •
edited by karfau

We agreed that it makes sense to consistenly use template strings (using backticks) for XML snippets in our tests and examples. Since whitespace matters when parsing/serializing XML, they should not be "wrapped" with any "tag", so it's obvious what is going on.

It is important to make changes in a way that no tests break/no snapshot files are updated, otherwise PRs will not be accepted/changes will be requested.
@brodybits brodybits added the bug Something isn't working label Sep 18, 2020
@brodybits brodybits added this to the 0.5.0 milestone Sep 18, 2020
@brodybits brodybits self-assigned this Sep 18, 2020
@karfau

This comment has been minimized.

Sign in to view
@karfau karfau removed this from the 0.5.0 milestone Jan 21, 2021
@karfau

This comment has been minimized.

Sign in to view
@karfau karfau closed this as completed Jan 21, 2021
@brodybits

This comment has been minimized.

Sign in to view
@brodybits brodybits reopened this Jan 25, 2021
@karfau

This comment has been minimized.

Sign in to view
@karfau karfau added code style testing and removed bug Something isn't working labels Jan 25, 2021
@brodybits brodybits changed the title Odds & ends from Prettier formatting of test code [PR #123] Use dedent or outdent for XML in test code [PR #123] Jan 25, 2021
@brodybits brodybits changed the title Use dedent or outdent for XML in test code [PR #123] Improve XML string blocks in test code [PR #123] Jan 25, 2021
@brodybits brodybits mentioned this issue Jan 25, 2021
Closed
@brodybits
Copy link
Member Author

#183 (comment)

Shouldn't we nowadays just use template strings everywhere, consistently?

Makes sense to me, yes.

@karfau karfau added documentation Improvements or additions to documentation good first issue Good for newcomers help-wanted External contributions welcome labels Aug 23, 2021
@karfau
Copy link
Member

karfau commented Aug 23, 2021

I updated the description (including removing previous confusing content) to match what we have discussed here

@karfau karfau changed the title Improve XML string blocks in test code [PR #123] Consistently use template strings for XML snippets in tests and examples Aug 23, 2021
@karfau karfau changed the title Consistently use template strings for XML snippets in tests and examples Consistently use template strings for XML snippets Aug 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@brodybits brodybits

Labels
code style documentation Improvements or additions to documentation good first issue Good for newcomers help-wanted External contributions welcome testing
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve some XML test strings brodybits/xmldom
2 participants
@karfau @brodybits