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

Code style doc page #103

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Conversation

Keyikedalube
Copy link
Contributor

@Keyikedalube Keyikedalube commented May 22, 2023

Added them to Contributing guidelines section

Some of the topics I skipped where the vote was 50-50.
Still more pending topics to add but I guess the initial draft is the best time when modification is less painful XD

All topics added to the best of my knowledge reading the forum.
Any criticisms are welcome.
Also since we are low in manpower I might mark this PR as ready to merge in July so it doesn't stay in draft mode forever.

@Keyikedalube Keyikedalube marked this pull request as draft May 23, 2023 01:56

// Same apply for C++ loops too

while (condition) { ... }
Copy link
Contributor

Choose a reason for hiding this comment

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

avoid single line :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Wanted to keep the section topics minimal so I just lumped the below discussion in this portion too ;P

For consistency's sake, a new separate section would be much better. Updating the doc...

Screenshot_2023-05-23_16-48-47

// - Brace on the new line
// - And no space before function bracket

void my_function()
Copy link
Contributor

Choose a reason for hiding this comment

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

Was defined we should keep this style below?

void
my_function()
{
}

Copy link
Contributor Author

@Keyikedalube Keyikedalube May 23, 2023

Choose a reason for hiding this comment

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

LOL the vote was 50-50 I didn't know what to choose without offending the other parties XD

Synfig and GTKMM code specifically tend to have lengthy return types so I voted your above style in the forum. Also, GTK dev team uses/recommends that in their codebase too.

I'll update the doc anyway... 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants