Update variables documentation #1203
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Do we have an example of using ill-formed xml as a variable? Some might assume the value needs to be well-formed even if it was never mentioned. |
ok I see the point. I didn't document this as I felt that it should be the expected behaviour. |
ang-zeyu
force-pushed
the
update-variable-docs
branch
3 times, most recently
from
fa586d4
to
ec48c07
Compare
ang-zeyu
changed the title
le0tan
added
the
pr.DocsUpdate 📃
ang-zeyu
force-pushed
the
update-variable-docs
branch
from
ec48c07
to
39dea1a
Compare
The limitation of variables not being able to contain incomplete or malformed xml has been patched. Some areas of the variable documentation can also be formatted with newly introduced features to be more visually appealing. Let’s update the user guide to reflect the patch, and reformat some areas of the variable documentation.
ang-zeyu
force-pushed
the
update-variable-docs
branch
from
39dea1a
to
d1543fb
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of this pull request? (put "X" next to an item, remove the rest)
• [x] Documentation update for #1193 and some reformatting for variable documentation
Proposed commit message: (wrap lines at 72 characters)
Update variable documentation
The limitation of variables not being able to contain incomplete or
malformed xml has been patched.
Some areas of the variable documentation can also be formatted with
newly introduced features to be more visually appealing.
Let’s update the user guide to reflect the patch, and reformat some
areas of the variable documentation.