Improve context docs #588
Improve context docs #588
Conversation
pages/en/lb4/Decorators.md
Outdated
|
|
||
| A few variants of `@inject` are provided to declare special forms of dependencies: | ||
|
|
||
| - @inject.getter: inject a getter function that returns a promise of the bound value of the key |
There was a problem hiding this comment.
Missing backticks?
- `@inject.getter`: inject a getter function etc.
pages/en/lb4/Decorators.md
Outdated
| } | ||
| ``` | ||
|
|
||
| - @inject.setter: inject a setter function to set bound value of the key |
There was a problem hiding this comment.
Missing backticks?
- `@inject.setter`: inject a setter function etc.
pages/en/lb4/Decorators.md
Outdated
| } | ||
| ``` | ||
|
|
||
| - @inject.tag: inject an array of values by a pattern or regexp to match bindng tags |
pages/en/lb4/Creating-decorators.md
Outdated
| summary: A tutorial to use `@loopback/metadata` module to create new decorators | ||
| --- | ||
|
|
||
| [Create decorators](https://github.com/strongloop/loopback-next/blob/master/packages/metadata/README.md) |
There was a problem hiding this comment.
An empty page with a single link to external README is suboptimal. Could you please use the mechanism we have already in place for sourcing content from README files?
See http://loopback.io/doc/en/contrib/Including-READMEs.html and http://loopback.io/doc/en/contrib/readmes.html
There was a problem hiding this comment.
Yes, I was trying to do so but the current tooling does not seem to support a monorepo (loopback-next).
There was a problem hiding this comment.
the current tooling does not seem to support a monorepo (loopback-next).
Could you please be more specific? What is the current problem and how much work would it be to fix it? If you prefer to land this PR first, then I am ok with that as long as there is a follow-up issue so that we don't forget to fix this problem.
bajtos
left a comment
bajtos
left a comment
There was a problem hiding this comment.
Assuming that the new script update-v4-readmes.sh works as intended, you need to update Jenkinsfile to fetch these new READMEs and commit them to github.
Other than that, the patch LGTM.
raymondfeng
force-pushed
the
improve-context-docs
branch
from
934c889 to
3e3e51a
Compare
|
@bajtos I added v4 readme steps in Jenkinsfile. I'll merge the PR to see it works as expected as I cannot tell it locally. |
|
For the record, http://loopback.io/doc/en/lb4/Creating-decorators.html is live now. :-) |
👏 There is one glitch to fix though: the note "This page was generated from the metadata README." is pointing to a wrong GitHub URL: https://github.com/strongloop/metadata Ideally, the note should say @raymondfeng ☝️ |
This is a follow-up to #588
This is a follow-up to #588
This is a follow-up to #588
This is a follow-up to #588
Doc updates for
@loopback/context.