telefonicaid / telefonicaid/iotagent-node-lib
[DOC] Add reusing context generated in expression to doc
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 62
- Forks
- 90
- Avg merge
- 2h 35m
- Merged PRs (30d)
- 1
Description
Include documentation about how to reuse context generated by expressions on subsequent expressions.
Preferred place:
https://github.com/telefonicaid/iotagent-node-lib/blob/master/doc/api.md#expression-language-support
Evaluate to include a new section talking about context
Add a note about expressions execution orders (by array order) and warning about Interdependencies. Context is evaluated in order
Another point, that is not included in the documentation, in that multientity plugin is now supporting expressions to generate the entity name destination
Related PR: https://github.com/telefonicaid/iotagent-node-lib/pull/1370
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in doc/api.md at the Expression Language Support section and read the existing expression documentation. Document how context generated by one expression can be reused by later expressions, explain array-order execution and interdependency warnings, and cover multientity expressions that generate the destination entity name. Review related PR 1370 before making changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100