Skip to content

Enhance Json Variable Doc with scope example#1208

Merged
ang-zeyu merged 2 commits intoMarkBind:masterfrom
crphang:enhance-jsonvar-doc
Jun 9, 2020
Merged

Enhance Json Variable Doc with scope example#1208
ang-zeyu merged 2 commits intoMarkBind:masterfrom
crphang:enhance-jsonvar-doc

Conversation

@crphang
Copy link
Contributor

@crphang crphang commented Apr 19, 2020

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] Documentation update

Resolves #1202

What is the rationale for this request?

Elaborate on how JSON variable is scoped.

What changes did you make? (Give an overview)

Added documentation.

Provide some example code that this change will affect:

N/A

Is there anything you'd like reviewers to focus on?

Clarity of documentation.

Testing instructions:

N/A
Proposed commit message: (wrap lines at 72 characters)

Enhance Json Variable Doc with scope example

@le0tan le0tan added the pr.DocsUpdate 📃 Pure changes to the documentation, such as typo, restructuring, etc label Apr 22, 2020
@crphang
Copy link
Contributor Author

crphang commented Apr 27, 2020

Ready for review

Copy link
Contributor

@ang-zeyu ang-zeyu left a comment

Choose a reason for hiding this comment

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

minor nits:

```

Variables defined in JSON file will be scoped according to where it is being referenced.
Variables defined in JSON file will be scoped according to where it is being referenced. For json variables referenced in `variables.md`
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Variables defined in JSON file will be scoped according to where it is being referenced. For json variables referenced in `variables.md`
Variables defined in a JSON file will be scoped according to where it is being referenced. JSON variables referenced in `variables.md`


Variables defined in JSON file will be scoped according to where it is being referenced.
Variables defined in JSON file will be scoped according to where it is being referenced. For json variables referenced in `variables.md`
would be globally scoped like other global variables in that file. On the other hand:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
would be globally scoped like other global variables in that file. On the other hand:
would be globally scoped like other global variables in that file.

@ang-zeyu
Copy link
Contributor

ang-zeyu commented Jun 9, 2020

Resolved a minor conflict and merged in the suggestions for now, do let me know if the suggestions weren't what you meant!

@ang-zeyu ang-zeyu added this to the v2.15.0 milestone Jun 9, 2020
@ang-zeyu ang-zeyu merged commit 38803c8 into MarkBind:master Jun 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr.DocsUpdate 📃 Pure changes to the documentation, such as typo, restructuring, etc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

JSON variables: elaborate on scoping

3 participants