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

Add Docs to XCM-Simulator Macros #3542

Closed
shawntabrizi opened this issue Aug 1, 2021 · 3 comments · Fixed by #6178
Closed

Add Docs to XCM-Simulator Macros #3542

shawntabrizi opened this issue Aug 1, 2021 · 3 comments · Fixed by #6178
Labels
I7-documentation Documentation needs fixing, improving or augmenting. T6-XCM This PR/Issue is related to XCM.

Comments

@shawntabrizi
Copy link
Member

shawntabrizi commented Aug 1, 2021 •
edited
Loading

See comments here #3538
@shawntabrizi shawntabrizi added I7-documentation Documentation needs fixing, improving or augmenting. Q1-mentor labels Aug 1, 2021
@shawntabrizi shawntabrizi mentioned this issue Aug 1, 2021
Merged
@KiChjang KiChjang added the T6-XCM This PR/Issue is related to XCM. label Dec 24, 2021
@bizzyvinci
Copy link
Contributor

Hi @shawntabrizi. What are the steps to get this done?

@shawntabrizi
Copy link
Member Author

@bizzyvinci the macros in this file have no usability documents:

https://github.com/paritytech/polkadot/blob/master/xcm/xcm-simulator/src/lib.rs

There are some examples, but the macros themselves should have docs saying how to use them and what kinds of things that may work or break them.

@bizzyvinci
Copy link
Contributor

This is my first time writing docs. Are there guidelines and good samples?

@Szegoo Szegoo mentioned this issue Oct 22, 2022
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
I7-documentation Documentation needs fixing, improving or augmenting. T6-XCM This PR/Issue is related to XCM.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Xcm-Simulator Docs Szegoo/polkadot
3 participants
@shawntabrizi @KiChjang @bizzyvinci