Skip to content

Conversation

@kianenigma
Copy link
Contributor

@kianenigma kianenigma commented Feb 28, 2024

This fixes an issue introduced in paritytech/substrate#14101, in which I removed the Call enum's documentation and replaced it with a link to the Pallet struct, but this also removed any docs related to call from the metadata.

I tried to add a regression test for this, but it seems to me that this is not possible, given that using type-info we only assert in type-ids for Call, Event and Error. I removed some doc comments from a test setup in frame-support-test to demonstrate the issue there. @jsdw do you have any comments on this?

I also fixed a small issue in the custom html/css of polkadot-sdk-doc crate, making sure it does not affect the rust-doc page of all other crates.

  • Investigate a regression test
  • prdoc

@kianenigma kianenigma added T1-FRAME This PR/Issue is related to core FRAME, the framework. T2-pallets This PR/Issue is related to a particular pallet. T11-documentation This PR/Issue is related to documentation. labels Feb 28, 2024
@kianenigma kianenigma requested a review from a team as a code owner February 28, 2024 21:03
@bkchr
Copy link
Member

bkchr commented Feb 28, 2024

I tried to add a regression test for this, but it seems to me that this is not possible, given that using type-info we only assert in type-ids for Call, Event and Error

I don't get this comment? I mean you can find the documentation as well in the type info.

@kianenigma
Copy link
Contributor Author

I tried to add a regression test for this, but it seems to me that this is not possible, given that using type-info we only assert in type-ids for Call, Event and Error

I don't get this comment? I mean you can find the documentation as well in the type info.

You are right, thank you! I just needed to explore a bit more to find the right way to access it.

@kianenigma kianenigma changed the title Fix call enum's metadata regression' Fix call enum's metadata regression Feb 29, 2024
@kianenigma kianenigma added this pull request to the merge queue Feb 29, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Feb 29, 2024
@kianenigma kianenigma added this pull request to the merge queue Feb 29, 2024
Merged via the queue into master with commit c0e52a9 Feb 29, 2024
@kianenigma kianenigma deleted the kiz-fix-call-doc-regression branch February 29, 2024 19:31
ordian added a commit that referenced this pull request Mar 1, 2024
…head-data

* origin/master:
  Fix call enum's metadata regression (#3513)
  Enable elastic scaling node feature in local testnets genesis (#3509)
  update development setup in sdk-docs (#3506)
  Fix accidental no-shows on node restart (#3277)
  Remove `AssignmentProviderConfig` and use parameters from `HostConfiguration` instead (#3181)
  [Deprecation] Remove sp_weights::OldWeight (#3491)
  Fixup multi-collator parachain transition to async backing (#3510)
  Multi-Block-Migrations, `poll` hook and new System callbacks (#1781)
  Snowbridge - Extract Ethereum Chain ID (#3501)
  PVF: re-preparing artifact on failed runtime construction (#3187)
  Add documentation around FRAME Offchain workers (#3463)
  [prdoc] Optional SemVer bumps and Docs (#3441)
  rpc-v2/tx/tests: Add transaction broadcast tests and check propagated tx status (#3193)
ordian added a commit that referenced this pull request Mar 1, 2024
…data

* ao-collator-parent-head-data:
  Fix call enum's metadata regression (#3513)
  Enable elastic scaling node feature in local testnets genesis (#3509)
  update development setup in sdk-docs (#3506)
  Fix accidental no-shows on node restart (#3277)
  Remove `AssignmentProviderConfig` and use parameters from `HostConfiguration` instead (#3181)
  [Deprecation] Remove sp_weights::OldWeight (#3491)
  Fixup multi-collator parachain transition to async backing (#3510)
  Multi-Block-Migrations, `poll` hook and new System callbacks (#1781)
  Snowbridge - Extract Ethereum Chain ID (#3501)
  PVF: re-preparing artifact on failed runtime construction (#3187)
  Add documentation around FRAME Offchain workers (#3463)
  [prdoc] Optional SemVer bumps and Docs (#3441)
  rpc-v2/tx/tests: Add transaction broadcast tests and check propagated tx status (#3193)
skunert pushed a commit to skunert/polkadot-sdk that referenced this pull request Mar 4, 2024
This fixes an issue introduced in
paritytech/substrate#14101, in which I removed
the `Call` enum's documentation and replaced it with a link to the
`Pallet` struct, but this also removed any docs related to call from the
metadata.

I tried to add a regression test for this, but it seems to me that this
is not possible, given that using `type-info` we only assert in type-ids
for `Call`, `Event` and `Error`. I removed some doc comments from a test
setup in `frame-support-test` to demonstrate the issue there. @jsdw do
you have any comments on this?

I also fixed a small issue in the custom html/css of `polkadot-sdk-doc`
crate, making sure it does not affect the rust-doc page of all other
crates.

- [x] Investigate a regression test
- [x] prdoc
bgallois pushed a commit to duniter/duniter-polkadot-sdk that referenced this pull request Mar 25, 2024
This fixes an issue introduced in
paritytech/substrate#14101, in which I removed
the `Call` enum's documentation and replaced it with a link to the
`Pallet` struct, but this also removed any docs related to call from the
metadata.

I tried to add a regression test for this, but it seems to me that this
is not possible, given that using `type-info` we only assert in type-ids
for `Call`, `Event` and `Error`. I removed some doc comments from a test
setup in `frame-support-test` to demonstrate the issue there. @jsdw do
you have any comments on this?

I also fixed a small issue in the custom html/css of `polkadot-sdk-doc`
crate, making sure it does not affect the rust-doc page of all other
crates.

- [x] Investigate a regression test
- [x] prdoc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

T1-FRAME This PR/Issue is related to core FRAME, the framework. T2-pallets This PR/Issue is related to a particular pallet. T11-documentation This PR/Issue is related to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants