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

Fix Writing a package section of Move doc #1172

Merged
merged 5 commits into from
Apr 4, 2022
Merged

Conversation

Clay-Mysten
Copy link
Contributor

Fix Writing a package section of Move doc

Fix Writing a package section of Move doc
@Clay-Mysten Clay-Mysten requested review from awelc and lxfind March 31, 2022 18:48
@huitseeker huitseeker added the Type: Documentation Improvements or additions to documentation label Mar 31, 2022
@Clay-Mysten Clay-Mysten requested a review from huitseeker March 31, 2022 20:08
described earlier:
described earlier.

Navigate (`cd`) into the `sui` directory and run:
Copy link
Contributor

Choose a reason for hiding this comment

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

This does not reflect the code structure as the my_move_package directory is "parallel" to `sui' in the hierarchy diagram.

Reading further I can see that this is intentional, but I am not sure if this is the best idea. The intention behind these directories being "parallel" was to avoid "polluting" the cloned Sui repository this way and in my opinion it's a cleaner approach.

Either way, we need to change the dir structure diagrams or the (new) text for consistency.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ahh, I see now. Let me rework this change given that intention. Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've now put this back in order. Sorry for my confusion.

Updating change to reflect `my_move_package` and `sui` directories are parallel
@Clay-Mysten Clay-Mysten requested a review from awelc April 4, 2022 20:57
@Clay-Mysten Clay-Mysten merged commit d755dad into main Apr 4, 2022
@Clay-Mysten Clay-Mysten deleted the Clay-Mysten-patch-19-1 branch April 4, 2022 21:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants