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

Add a draft for a standard module style guide #17675

Merged
merged 2 commits into from
May 13, 2021

Conversation

mppf
Copy link
Member

@mppf mppf commented May 11, 2021

Add a draft for a standard module style guide

This PR adds a draft standard module style guide as an aid for the effort of stabilizing the standard modules.
Based in large part upon #6698.

Discussed with lots of people but final review is by @bradcray - thanks!

---
Signed-off-by: Michael Ferguson <mppf@users.noreply.github.com>
@gbtitus
Copy link
Member

gbtitus commented May 11, 2021

This looks like a fine start. You might add a section saying that in modules that are strictly providing access to other interfaces (as for example Sys provides POSIX), the symbol capitalization should match that of the external interface.

@bradcray
Copy link
Member

Thanks for taking a start at this, Michael. Other than the comments above, this looks good to me and captures the sorts of things I agree that we've generally agreed upon. No other obvious cases leapt to mind, but I'll keep thinking about it as we proceed.

@mppf
Copy link
Member Author

mppf commented May 11, 2021

FYI for those who have already commented @vasslitvinov pointed out a guidance piece to add to it

A property method needs to be parenthesized if it is named isXXX or hasXXX, otherwise it should be paren-less.

I plan to incorporate this.

---
Signed-off-by: Michael Ferguson <mppf@users.noreply.github.com>
@mppf
Copy link
Member Author

mppf commented May 12, 2021

@bradcray - I've created a version incorporating people's feedback. Could you have a final look at it before I merge it? Thanks.

@bradcray
Copy link
Member

I think this is good to go as a starting point, thanks!

@mppf mppf merged commit 116edf5 into chapel-lang:master May 13, 2021
@mppf mppf deleted the standard-module-style branch May 13, 2021 13:20
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.

5 participants