Document html_nested! macro and add regression doc-tests for #1527

[Mingun]

Description

Documentation for html_nested!, typical usage and regression tests for #1527 in documentation

Checklist:

• I have run ./ci/run_stable_checks.sh
• I have reviewed my own code
• I have added tests

[siku2]

@Mergifyio update

[mergify]

Command update: success

Branch has been successfully updated

[siku2]

Thanks a lot for this! I left a few comments for the code snippets but there are also a few language issues that should be fixed.
Perhaps @teymour-aldridge is willing to take a look? Otherwise I'll do it tomorrow.

[teymour-aldridge]

I think that some of this should move from the doc comment into the accompanying documentation.
This is just an initial pass picking up some spelling/grammar errors.
The suggestions are just suggestions, and are more to point out where I think there are mistakes than my pushing for my suggested phrasing/wording to be adopted.

[siku2]

@teymour-aldridge, I agree, at the very least html_nested! should be mentioned in the documentation. I think that should be done through a follow-up PR though.

[teymour-aldridge]

I'm thinking that there's too much here for a doc comment and some of this should be moved into the docs.

[siku2]

Yeah, especially compared to the API docs of the html! macro. It makes more sense to explain the intrinsic details in the documentation. I'm saying we should leave it as is for this PR so we at least have something for now and then move it to the documentation in another PR so as not to put more work on @Mingun.

[teymour-aldridge]

Sounds like a plan!

[Mingun]

I've fix language, changed From to Into and add small note to html! about existing html_nested! and manual.

Yeah, especially compared to the API docs of the html! macro. It makes more sense to explain the intrinsic details in the documentation.

Actually, I'm prefer to have some very basics concepts in the rustdoc too. At least basic example of using html!, and example for dynamic tags (the last thing even isn't documented in manual). Manual mostly for deep understanding concepts, rustdoc -- for dirty copying examples of code :)

[siku2]

Just a few issues left.

[Mingun]

Failed documentation tests -- GitHub issue.

[siku2]

Thanks, @Mingun!