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

improve documentation for [dynamicxml] service #9798

Merged
merged 1 commit into from Dec 13, 2023

Conversation

chris48s
Copy link
Member

This is a follow up from #9784

I've attempted to document the point raised there, although I found it slightly tricky to explain it in a completely general way without referencing an example.

I also made a couple of other minor improvements while I was there.

@chris48s chris48s added service-badge Accepted and actionable changes, features, and bugs documentation Developer and end-user documentation labels Dec 10, 2023
Copy link
Contributor

Warnings
⚠️ This PR modified service code for dynamic but not its test code.
That's okay so long as it's refactoring existing code.
Messages
📖 ✨ Thanks for your contribution to Shields, @chris48s!

Generated by 🚫 dangerJS against 8eca581

Comment on lines +21 to +24
Note: For XML documents that use a default namespace prefix, you will need to use the
[local-name](https://developer.mozilla.org/en-US/docs/Web/XPath/Functions/local-name)
function to construct your query.
For example \`/*[local-name()='myelement']\` rather than \`/myelement\`.
Copy link
Member Author

Choose a reason for hiding this comment

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

@Washingtonwei - a question for you here: If this had been in the documentation on the website, do you think this would have been enough to allow you to work out #9784 without raising an issue?

If not, can you suggest any improvements that don't relate to a specific XML document?

Choose a reason for hiding this comment

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

This is perfect! Thank you!

Copy link
Member

@calebcartwright calebcartwright left a comment

Choose a reason for hiding this comment

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

Looks like a positive improvement to me, but will hold off adding to the queue in case there's any additional suggestions

@chris48s chris48s added this pull request to the merge queue Dec 13, 2023
Merged via the queue into badges:master with commit cee41f5 Dec 13, 2023
23 checks passed
@chris48s chris48s deleted the dynamic-xml-docs branch December 13, 2023 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Developer and end-user documentation service-badge Accepted and actionable changes, features, and bugs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants