update genesis_config related docs and tests and error messages

[kianenigma]

Follow-up to paritytech/substrate#14306.

I hope this also showcases the important message of: It is really not that hard to make the examples codes in rust-docs compile, and therefore remain correct. Please embrace this :)

It moves the documentation of proc macros to their re-export, such that can link other items in frame-support. This is a patter that we should embrace for all of macro docs, and apply in PRs like paritytech/substrate#13987 as well.

[sam0x17]

This is fine, but keep in mind if doing this technique, unless something has changed since the last time I checked, rust analyzer will not pick up on the re-export docs when hovering over those items, so it might make sense to put the "main docs" for the thing on the actual item, and the "examples" on the re-export. I think rustdoc will put one before the other and I forget which order but worth playing around with to see if we can get some docs in RA and all the docs in everything else instead of no docs in RA because that defeats the purpose of the stubs.

This was the reason for the documented macro stubs that I added

[kianenigma]

I think rustdoc will put one before the other and I forget which order but worth playing around with to see if we can get some docs in RA and all the docs in everything else instead of no docs in RA because that defeats the purpose of the stubs.

The one on the re-export goes first, so putting the example first is a weird experience..

Thanks for pointing this out. I would have to find another alternative. This is still a pretty much unsolved issue. Why is it that RA will get the stubs first, and not the re-exports?

UPDATE:

if we target having two umbrella crates, it might be solve-able, I think you also hinted at this at some point.

• frame exports all types
• frame-macros exports all macros.
• frame-macros relies on frame
• user have to bring in frame and frame-macros, so there would be no re-exports.

[ggwpez]

bot update-ui substrate --rust_version=1.70

[command-bot]

@ggwpez https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/3752654 was started for your command "$PIPELINE_SCRIPTS_DIR/commands/update-ui/update-ui.sh" --target_path=./substrate --rust_version=1.70. Check out https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/pipelines?page=1&scope=all&username=group_605_bot to know what else is being executed currently.

Comment bot cancel 6-13bc1723-4451-41f5-bddd-fea4c9e29036 to cancel this command or bot cancel to cancel all commands in this pull request.

[command-bot]

@ggwpez Command "$PIPELINE_SCRIPTS_DIR/commands/update-ui/update-ui.sh" --target_path=./substrate --rust_version=1.70 has finished. Result: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/3752654 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/3752654/artifacts/download.

[franciscoaguirre]

Love functioning doc tests 😍

[kianenigma]

I was not done lol :D

[kianenigma]

In retrospect, this was part of #247