-
-
Notifications
You must be signed in to change notification settings - Fork 947
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
WIP: Clean up Wallet code samples #1116
WIP: Clean up Wallet code samples #1116
Conversation
Thanks for this @FaybianB! One comment I have so far is that for all the code samples with metadata such as titles and highlighted line numbers, the formatter may have automatically removed them. Can you add those back? |
Hey @alexandratran, yes, I can do that. Do you have any suggestions for some consistent guidelines that you would like the metadata to follow? I notice some code samples do not have metadata, while others have a title and others have titles and line numbers. |
@FaybianB I think it would be ideal for as many code samples as possible to have file names as titles, but that might be a more involved task for a future PR. For now, we can probably just keep the the current titles as they are. Only a couple of the tutorials have code samples with line numbers, in order to highlight and describe certain parts of the code. It's also fine for only those samples to have line numbers for now. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
@FaybianB Looks like there's a lot of merge conflicts on this PR since we've recently made some updates to the structure of the docs. Let me know if you want me to take over and clean up this PR! |
@alexandratran Thanks for letting me know, I would like to resolve the conflicts and finish this PR. |
Resolves: #1099
This pull request attempts to ensure that the code samples in the docs follow some consistent style guideline. To accomplish this, the code samples were formatted using the Prettier formatter plugin and the following rules: