Add docs to lib.rs + macros.rs. Simplify clone! #49
Conversation
|
@Pauan these docs are very nice, could you mind merging it? |
|
These docs are very helpful! They would have helped me understand dominator a lot more easily and quickly. @Pauan anything blocking merging these? |
|
@AndrewMorsillo It's just a very large change, so I haven't been able to find the time to review it. |
|
@Pauan would it be OK if someone other than you reviewed it? |
There was a problem hiding this comment.
Hi @Pauan, first of all, thank you so much for dominator and rust-signals, they are quite a treat!
Would it help if such PR was broken into smaller pieces? For example:
- Lib intro (a must have for the docs.rs/dominator landing page)
- Macro docs
- clone! refactor
| //! `dominator` handles any necessary DOM updates on changes to the data. A basic app looks something like the | ||
| //! below, but refer to the [examples](https://github.com/Pauan/rust-dominator/tree/master/examples) for a | ||
| //! comprehensive set of best practices. | ||
| //! ``` |
There was a problem hiding this comment.
Would be nice to ensure the examples compile, e.g. using:
| //! ``` | |
| //! ```rust |
or
| //! ``` | |
| //! ```no_run |
|
It was a long time since I submitted this, however I'm still using Dominator regularly. I could easily change it to one macro at a time etc. |
|
@TristanCacqueray Yes, small bite-sized pull requests are much much much much easier to review, since I don't need to devote a large chunk of time to reviewing it. Ideally a pull request per method / macro. |
Hi @Pauan,
I've started adding some docs based on my experience of using dominator and also all the gold in the Discord that we get from asking you questions 😄 . I also updated the
clonemacro which may constitute a breaking change...