update genesis_config related docs and tests and error messages
#1642
Conversation
kianenigma
added
the
T11-documentation
kianenigma
changed the title
genesis_config related docs and tests and error messages
Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>
Co-authored-by: joe petrowski <25483142+joepetrowski@users.noreply.github.com>
…genesis-config-docs
|
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 |
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.
|
|
bot update-ui substrate --rust_version=1.70 |
|
@ggwpez https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/3752654 was started for your command Comment |
…rate --rust_version=1.70
|
@ggwpez Command |
|
I was not done lol :D |
|
In retrospect, this was part of #247 |
#1689) Small tweak to #1642 to incorporate the ideas from #247. I think this is the good middle ground, where we have good rust-docs, and the RA users will also have some hope. cc @wentelteefje @aaronbassett @sam0x17
…ritytech#1642) 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. --------- Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com> Co-authored-by: joe petrowski <25483142+joepetrowski@users.noreply.github.com> Co-authored-by: command-bot <>
paritytech#1689) Small tweak to paritytech#1642 to incorporate the ideas from paritytech#247. I think this is the good middle ground, where we have good rust-docs, and the RA users will also have some hope. cc @wentelteefje @aaronbassett @sam0x17
* remove message fee * it is compiling! * fixes + fmt * more cleanup * more cleanup * restore MessageDeliveryAndDispatchPayment since we'll need relayer rewards * started rational relayer removal * more removal * removed estimate fee subcommand * remove DispatchFeePayment * more removals * removed conversion rates && some metrics * - unneeded associated type * - OutboundMessageFee * fix benchmarks compilation * fmt * test + fix benchmarks * fix send message * clippy
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.