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

contributing: update style guide for C #4312

Merged
merged 2 commits into from
Sep 12, 2024

Conversation

petrasovaa
Copy link
Contributor

This PR adds relevant info from https://trac.osgeo.org/grass/wiki/Submitting/C as mentioned here. I left out some subsections from it, because I was not sure whether they are relevant, for example note about void functions.

I also added missing info about the python addon template and header.

@petrasovaa petrasovaa added this to the 8.5.0 milestone Sep 12, 2024
@petrasovaa petrasovaa self-assigned this Sep 12, 2024
@github-actions github-actions bot added the docs label Sep 12, 2024
Copy link
Contributor

@nilason nilason left a comment

Choose a reason for hiding this comment

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

Looks good to me, some minor notes only.

The CI runners will complain with absent void, so I believe there's no need for that info specifically.

Perhaps you can bump the note on ClangFormat version to:
(currently with version 18+), while updating the file.

doc/development/style_guide.md Show resolved Hide resolved
doc/development/style_guide.md Outdated Show resolved Hide resolved
Copy link
Contributor

@nilason nilason left a comment

Choose a reason for hiding this comment

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

Great! Always difficult to draw the line on what to include here and still keep it short, if something comes up we can always update.

@petrasovaa petrasovaa enabled auto-merge (squash) September 12, 2024 18:18
@petrasovaa petrasovaa merged commit 9aeabc1 into OSGeo:main Sep 12, 2024
23 checks passed
neteler pushed a commit that referenced this pull request Sep 12, 2024
@neteler neteler modified the milestones: 8.5.0, 8.4.1 Sep 12, 2024
Mahesh1998 pushed a commit to Mahesh1998/grass that referenced this pull request Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants