Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Create a README for XCMv2 detailing notable changes #4059

Merged
merged 7 commits into from
Dec 18, 2021

Conversation

KiChjang
Copy link
Contributor

No description provided.

@KiChjang KiChjang added A0-please_review Pull request needs code review. B1-releasenotes C1-low PR touches the given topic and has a low impact on builders. D2-notlive 💤 PR contains changes in a runtime directory that is not deployed to a chain that requires an audit. labels Oct 12, 2021
@apopiak
Copy link
Contributor

apopiak commented Oct 12, 2021

btw. if the content is the same you could potentially just use https://github.com/livioribeiro/cargo-readme to generate the readme.md

Copy link
Contributor

@apopiak apopiak left a comment

Choose a reason for hiding this comment

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

LGTM

Comment on lines -3 to -7

## Changes to be aware of
Most changes should automatically be resolved via the conversion traits (i.e. `TryFrom` and `From`). The list here is mostly for incompatible changes that result in an `Err(())` when attempting to convert XCM objects from v0.

### Junction
Copy link
Member

Choose a reason for hiding this comment

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

why remove this file?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There was a discussion where we agreed that we shouldn't maintain duplicated information on 2 different locations (i.e. both on the README.md and the top-level doc comments for the Rust module), and so I opted for only writing it on the top-level doc comments.

@KiChjang
Copy link
Contributor Author

bot merge

@paritytech-processbot paritytech-processbot bot merged commit 9e6343b into master Dec 18, 2021
@paritytech-processbot paritytech-processbot bot deleted the kckyeung/xcm-v2-readme branch December 18, 2021 06:05
ordian added a commit that referenced this pull request Dec 20, 2021
* master:
  dispute-coordinator: fix underflow panic (#4557)
  Bump futures from 0.3.18 to 0.3.19 (#4567)
  Bump lru from 0.7.0 to 0.7.1 (#4566)
  Update Polkadot (#4561)
  Suggest installing graphviz before book building (#4565)
  [Zombienet] fix test creds (#4562)
  chain-api: stop ancestors lookup at block #0 (#4560)
  use v1.0.2 of zombienet (#4553)
  remove invalid dispute subsystem replace (#4559)
  Bump hyper from 0.14.15 to 0.14.16 (#4550)
  Create a README for XCMv2 detailing notable changes (#4059)
  enable disputes for known chains, except for polkadot (#4464)
  dispute statements node side limiting (#4541)
  Bump serde from 1.0.131 to 1.0.132 (#4551)
  Bump nix from 0.23.0 to 0.23.1 (#4552)
  Dispute coordinator: look for included candidates in non-finalized chain (#4508)
drahnr pushed a commit that referenced this pull request Jan 4, 2022
* Create a README for XCMv2 detailing notable changes

* Typo

* Appease spellcheck and cargo fmt

* Add XCM pallet item to be aware of

* cargo fmt

* Remove all XCM README.md
Wizdave97 pushed a commit to ComposableFi/polkadot that referenced this pull request Feb 3, 2022
* Create a README for XCMv2 detailing notable changes

* Typo

* Appease spellcheck and cargo fmt

* Add XCM pallet item to be aware of

* cargo fmt

* Remove all XCM README.md
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A0-please_review Pull request needs code review. C1-low PR touches the given topic and has a low impact on builders. D2-notlive 💤 PR contains changes in a runtime directory that is not deployed to a chain that requires an audit.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants