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

Issue/6409 improve language reference documentation #6457

Closed

Conversation

Hugo-Inmanta
Copy link
Contributor

@Hugo-Inmanta Hugo-Inmanta commented Sep 5, 2023

Description

Improve language reference documentation

closes #6409

Self Check:

Strike through any lines that are not applicable (~~line~~) then check the box

  • Attached issue to pull request
  • Changelog entry
  • Type annotations are present
  • Code is clear and sufficiently documented
  • No (preventable) type errors (check using make mypy or make mypy-diff)
  • Sufficient test cases (reproduces the bug/tests the requested feature)
  • Correct, in line with design
  • End user documentation is included or an issue is created for end-user documentation (add ref to issue here: )
  • If this PR fixes a race condition in the test suite, also push the fix to the relevant stable branche(s) (see test-fixes for more info)

docs/language.rst Outdated Show resolved Hide resolved
docs/language.rst Outdated Show resolved Hide resolved
docs/language.rst Outdated Show resolved Hide resolved
Hugo-Inmanta and others added 2 commits September 6, 2023 10:54
Co-authored-by: arnaudsjs <2684622+arnaudsjs@users.noreply.github.com>
docs/language.rst Outdated Show resolved Hide resolved
docs/language.rst Show resolved Hide resolved
docs/language.rst Show resolved Hide resolved
docs/language.rst Outdated Show resolved Hide resolved
docs/language.rst Outdated Show resolved Hide resolved
docs/language.rst Outdated Show resolved Hide resolved
docs/language.rst Outdated Show resolved Hide resolved
docs/language.rst Outdated Show resolved Hide resolved
Hugo-Inmanta and others added 2 commits September 12, 2023 10:28
Co-authored-by: arnaudsjs <2684622+arnaudsjs@users.noreply.github.com>
Comment on lines +222 to +223
Unlike python's multi-line strings, only double quotes are supported to define a multi-line string i.e. ``"""`` is
valid, but ``'''`` is not.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was surprised by this

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes. Me too. I created a ticket to support this. In the meantime we just document well that single quotes are not supported.

@Hugo-Inmanta Hugo-Inmanta added the merge-tool-ready This ticket is ready to be merged in label Sep 13, 2023
@inmantaci
Copy link
Contributor

Processing this pull request

inmantaci pushed a commit that referenced this pull request Sep 13, 2023
# Description

Improve language reference documentation

closes #6409

# Self Check:

Strike through any lines that are not applicable (`~~line~~`) then check the box

- [x] Attached issue to pull request
- [x] Changelog entry
- [ ] Type annotations are present
- [ ] Code is clear and sufficiently documented
- [ ] No (preventable) type errors (check using make mypy or make mypy-diff)
- [ ] Sufficient test cases (reproduces the bug/tests the requested feature)
- [ ] Correct, in line with design
- [ ] End user documentation is included or an issue is created for end-user documentation (add ref to issue here: )
- [ ] If this PR fixes a race condition in the test suite, also push the fix to the relevant stable branche(s) (see [test-fixes](https://internal.inmanta.com/development/core/tasks/build-master.html#test-fixes) for more info)
@inmantaci
Copy link
Contributor

Merged into branches master in cb0b6b1

inmantaci pushed a commit that referenced this pull request Sep 13, 2023
# Description

Improve language reference documentation

closes #6409

# Self Check:

Strike through any lines that are not applicable (`~~line~~`) then check the box

- [x] Attached issue to pull request
- [x] Changelog entry
- [ ] Type annotations are present
- [ ] Code is clear and sufficiently documented
- [ ] No (preventable) type errors (check using make mypy or make mypy-diff)
- [ ] Sufficient test cases (reproduces the bug/tests the requested feature)
- [ ] Correct, in line with design
- [ ] End user documentation is included or an issue is created for end-user documentation (add ref to issue here: )
- [ ] If this PR fixes a race condition in the test suite, also push the fix to the relevant stable branche(s) (see [test-fixes](https://internal.inmanta.com/development/core/tasks/build-master.html#test-fixes) for more info)
@inmantaci inmantaci closed this Sep 13, 2023
@inmantaci inmantaci deleted the issue/6409-improve-language-reference-documentation branch September 13, 2023 06:07
@inmantaci
Copy link
Contributor

Processing #6493.

inmantaci pushed a commit that referenced this pull request Sep 13, 2023
Pull request opened by the merge tool on behalf of #6457
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge-tool-ready This ticket is ready to be merged in
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve language reference documentation
3 participants