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

Improve language reference documentation #6409

Closed
arnaudsjs opened this issue Aug 18, 2023 · 0 comments
Closed

Improve language reference documentation #6409

arnaudsjs opened this issue Aug 18, 2023 · 0 comments
Assignees
@Hugo-Inmanta
Labels
documentation Documentation change tiny Tiny issues

Comments

@arnaudsjs
Copy link
Contributor

arnaudsjs commented Aug 18, 2023 •
edited
Loading

The following information is missing in the language reference:

  • Mention that tripple-quoted strings are supported.
  • Mention that a tripple-quoted string has to be used to define a multi-line string.
  • How does escaping work in a string.
  • Mention how to append an element to a list.
@arnaudsjs arnaudsjs added documentation Documentation change tiny Tiny issues labels Aug 18, 2023
@arnaudsjs arnaudsjs changed the title Improve documentation regarding triple-quoted strings Improve language reference documentation Aug 18, 2023
@Hugo-Inmanta Hugo-Inmanta self-assigned this Sep 4, 2023
@Hugo-Inmanta Hugo-Inmanta mentioned this issue Sep 5, 2023
Closed
9 tasks
inmantaci pushed a commit that referenced this issue Sep 13, 2023
@Hugo-Inmanta @inmantaci
Add language reference documentation. (Issue #6409, PR #6457)
e4136d4 
# 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 pushed a commit that referenced this issue Sep 13, 2023
@Hugo-Inmanta @inmantaci
Add language reference documentation. (Issue #6409, PR #6457)
2692fb4 
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
Assignees

@Hugo-Inmanta Hugo-Inmanta

Labels
documentation Documentation change tiny Tiny issues
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Issue/6409 improve language reference documentation inmanta/inmanta-core
2 participants
@arnaudsjs @Hugo-Inmanta