-
Notifications
You must be signed in to change notification settings - Fork 229
Add more example code standards #1126
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
Conversation
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.
This guideline seems fine to me, but we can leave it open for a bit longer to see if anyone else has other preferences.
Co-authored-by: Dongdong Tian <[email protected]>
I find we use both `True` (
Shall we add an example in the first rule? e.g., ``True`` results in Meanwhile, shall we move this example in the first rule: ``style="v"`` results in |
Yes.
Yes. |
Co-authored-by: Meghan Jones <[email protected]>
Co-authored-by: Meghan Jones <[email protected]> Co-authored-by: Dongdong Tian <[email protected]>
Description of proposed changes
A code standard about string value is added in CONTRIBUTING.md (Originally posted in #983 (comment). See also #983 (comment) and #983 (comment)):
style="v"
.Fixes #983
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash commands are:
/format
: automatically format and lint the code/test-gmt-dev
: run full tests on the latest GMT development version