Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pallet-revive: Fix docs.rs #6896

Merged
merged 9 commits into from
Dec 18, 2024
Merged

pallet-revive: Fix docs.rs #6896

merged 9 commits into from
Dec 18, 2024

Conversation

athei
Copy link
Member

@athei athei commented Dec 14, 2024

  • Fixed failing docs.rs build for pallet-revive-uapi by fixing a wring attribute in the manifest (we were using default-target instead of targets)
  • Removed the macros defining host functions because the cfg attributes introduced in Add unstable-api feature flag to pallet-revive #6866 won't work on them
  • Added an docs.rs specific attribute so that the unstable-hostfn feature tag will show up on the functions that are guarded behind it.

@athei athei added the R0-silent Changes should not be mentioned in any release notes label Dec 14, 2024
@paritytech-workflow-stopper
Copy link

All GitHub workflows were cancelled due to failure one of the required jobs.
Failed workflow url: https://github.com/paritytech/polkadot-sdk/actions/runs/12329239896
Failed job name: fmt

@athei
Copy link
Member Author

athei commented Dec 16, 2024

bot fmt

@command-bot
Copy link

command-bot bot commented Dec 16, 2024

@athei https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/7924317 was started for your command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh". 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 12-b3e2c264-6940-48b3-9e82-7fb27be97e30 to cancel this command or bot cancel to cancel all commands in this pull request.

@command-bot
Copy link

command-bot bot commented Dec 16, 2024

@athei Command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh" has finished. Result: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/7924317 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/7924317/artifacts/download.

@athei athei requested review from pgherveou and jarkkojs December 16, 2024 16:10
Copy link
Contributor

@jarkkojs jarkkojs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see prdoc entry, should this have one? Description could explain migration to unstable_hostfn, which would then also help to review the PR overall.

I mean structure of this is like:

  1. There's actually only one quite scoped change.
  2. Rest "ripples" from that.

So explaining 1 would help others to understand this.

@athei
Copy link
Member Author

athei commented Dec 17, 2024

/cmd prdoc --audience runtime_dev

@athei
Copy link
Member Author

athei commented Dec 17, 2024

Ooops. Yeah we need a prdoc in order to bump the pallets on release. Generated from PR description.

@athei athei requested a review from jarkkojs December 17, 2024 16:28
@jarkkojs
Copy link
Contributor

Ooops. Yeah we need a prdoc in order to bump the pallets on release. Generated from PR description.

Hmm... there's a way to generate it? :-) I've created the file manually.

doc:
- audience: Runtime Dev
description: |-
- Fixed failing docs.rs build for `pallet-revive-uapi` by fixing a wring attribute in the manifest (we were using `default-target` instead of `targets`)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wring i.e. wiring?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is my only complaint, otherwise makes sense

@athei athei added this pull request to the merge queue Dec 18, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 18, 2024
@athei athei added this pull request to the merge queue Dec 18, 2024
Merged via the queue into master with commit 91bef33 Dec 18, 2024
198 of 202 checks passed
@athei athei deleted the at/fix_uapi_docs branch December 18, 2024 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
R0-silent Changes should not be mentioned in any release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants