Docs/standardization #243
Docs/standardization #243
Conversation
AxelPeter
commented
Aug 3, 2018
AxelPeter
commented
- Add CodeOwners and Github files
- Standardize all documentation files
- Fix provider methods
- Add transclude support
- Fix component templates
AxelPeter
force-pushed
the
docs/standardization
branch
from
9f8cf88 to
521bc42
Compare
|
I have done a rebase with the merge of #242 |
| @@ -0,0 +1 @@ | |||
| @AxelPeter @FredericEspiau @euhmeuh @JeremyDec | |||
.github/ISSUE_TEMPLATE.md
Outdated
|
|
||
| **Expected behavior:** | ||
|
|
||
| <!-- What you expect to happen--> |
There was a problem hiding this comment.
<-- What did you expect to happen -- >
.github/ISSUE_TEMPLATE.md
Outdated
| ### Description | ||
|
|
||
| <!-- Required --> | ||
| <!-- Description of the issue] --> |
.github/ISSUE_TEMPLATE.md
Outdated
| <!-- Required --> | ||
| <!-- Description of the issue] --> | ||
|
|
||
| ### Steps to Reproduce |
There was a problem hiding this comment.
### Steps to reproduce
.github/ISSUE_TEMPLATE.md
Outdated
| 2. [Second Step] | ||
| 3. [and so on...] | ||
|
|
||
| **Expected behavior:** |
There was a problem hiding this comment.
I don't think we need the :
packages/oui-checkbox/README.md
Outdated
| ### On change | ||
|
|
||
| **Note:** Model will not be refreshed until the `on-change` callback as not finished. If you want to access the new model inside the `on-change` callback you need to use the `modelValue` variable as below. | ||
| **Note**: Model will not be refreshed until the `on-change` callback as not finished. If you want to access the new model inside the `on-change` callback you need to use the `modelValue` variable as below. |
There was a problem hiding this comment.
If you want to access the new model inside the ``on-change`` callback you need to use the modelValue variable as below.
->
If you want to access the new model inside the ``on-change`` callback, you need to use the modelValue variable as below.
packages/oui-checkbox/README.md
Outdated
| | on-change | function | &? | | | | handler triggered when value has changed | ||
| | Attribute | Type | Binding | One-time Binding | Values | Default | Description | ||
| | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ||
| | `model` | nullable<boolean> | =? | no | `true`, `false`, `null` | n/a | current value of the checkbox and null is considered as `indeterminate` |
There was a problem hiding this comment.
nullable<boolean> -> boolean? to replicate C# behavior https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/nullable-types/?
or
nullable<boolean> -> boolean | nullto replicate TypeScript behaviors https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-0.html ?
| import clamp from "lodash/clamp"; | ||
|
|
||
| // By design, value is restricted to [0, 99999] interval | ||
| const MIN_VALUE = 0; |
There was a problem hiding this comment.
Why not Number.MIN_VALUE and Number.MAX_VALUE ?
| } | ||
|
|
||
| $postLink () { | ||
| // Sometimes the digest cycle is done before dom manipulation, |
There was a problem hiding this comment.
This shouldn't be specified everywhere, maybe have a document to explain the design choices
| } | ||
|
|
||
| setModelValue (value) { | ||
| // updates model and displayed value |
There was a problem hiding this comment.
Yes, I can read the code myself 😄. The method name says the exact same thing
AxelPeter
force-pushed
the
docs/standardization
branch
from
56d9512 to
83869e0
Compare
AxelPeter
force-pushed
the
docs/standardization
branch
from
83869e0 to
ad67796
Compare
3 participants
