-
Notifications
You must be signed in to change notification settings - Fork 12
t/41: Improved documentation of the Observable#bind
method
#253
Conversation
Could you move this to the deep dive section? I started moving long API docs like this out of API docs where there are hard to find and hard to read. You'll need to extend it a bit and link to it from some places in https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/framework/guides/architecture/ui-library.html and from API docs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's move it to the deep dive section of the documentation.
Move like "leave what I did here + extend it in the guide" or "discard what I did here and just write in the guide"? |
Like: cut what you wrote, paste it into the new guide, review if it makes sense outside (it will miss a context, so most likely it needs to be extended with some intro), add cross-links between various places. |
Ready for another round of review:
|
…ep dive guide. Adjusted the API docs of the method.
Having mixed the {@link module:utils/observablemixin~ObservableMixin} into your class, you can define observable properties. To do that, use the {@link module:utils/observablemixin~ObservableMixin#set `set()` method}. Let's set a couple of properties and see what they look like in a simple `Command` class: | ||
|
||
```js | ||
export default class Command { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is confusing. Especially the new Command( 'thing' )
used later on. We should base the docs on some realistic code and we don't write a code like this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See comments.
Co-Authored-By: oleq <a.nowodzinski@cksource.com>
Co-Authored-By: oleq <a.nowodzinski@cksource.com>
…e guide. Co-Authored-By: oleq <a.nowodzinski@cksource.com>
I'll merge this guide now because I'm basing some other changes in another repo on them. You can commit some fixes for it straight to |
Suggested merge commit message (convention)
Docs: Improved documentation of the
Observable#bind
method. Closes ckeditor/ckeditor5#4887.