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

Style guide (code / syntax) #49

Closed
paulyoung opened this issue Mar 3, 2016 · 15 comments
Closed

Style guide (code / syntax) #49

paulyoung opened this issue Mar 3, 2016 · 15 comments

Comments

@paulyoung
Copy link

Not to be confused with the guidelines for writing libraries, but something more in the style of Elm's style guide or NoRedInk's Elm Style Guide.

@texastoland
Copy link

@paulyoung This is on my personal todo! I have concrete ideas if you'd like to coordinate? I was thinking of publishing it with GitBook for a whirlwind syntax tour.

@paulyoung
Copy link
Author

Sounds great!

I may be providing more questions than answers 😄

@texastoland
Copy link

Sweet I'll gather my thoughts into a repo today!!

@texastoland
Copy link

@paulyoung I'm starting here if you wanna follow along. I'll publish conventions first based on several Haskell and Elm guides. NB for pedagogical sake it won't follow the style of our Prelude or compiler.

@paulyoung
Copy link
Author

@AppShipIt sounds good. Feel free to ping me if you make updates.

@tfausak
Copy link

tfausak commented Apr 22, 2016

I think this should go hand-in-hand with #23.

@texastoland
Copy link

I think #23 should be more flexible. At work I've pointed out the current conventions I deem awful e.g. vertical indentation. We're using recommendations based on Elm which I'll add to purescript-4humans.

@garyb
Copy link
Member

garyb commented Apr 22, 2016

What's "vertical indentation"?

@natefaubion
Copy link

purescript-4humans

Next: purescript-4dolphins 😉

@tfausak
Copy link

tfausak commented Apr 22, 2016

data Maybe a = Nothing
             | Just a
          -- ^ Lining this up is "vertical indentation".

Edit: ... I think.

@garyb
Copy link
Member

garyb commented Apr 22, 2016

The Elm style guide is against that too I thought? Unless I'm misunderstanding @AppShipIt.

👍 for not doing that.

@texastoland
Copy link

texastoland commented Apr 22, 2016

Right. Definitely planning on getting feedback!

@dkoontz
Copy link

dkoontz commented Jun 7, 2016

👍 for this. I've also been using the Elm style guide for PS at work and it's been very nice.

@ianbollinger
Copy link

I started work on one here, if anyone is interested.

@paf31
Copy link
Contributor

paf31 commented Jan 17, 2017

Moving to the docs repo.

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

No branches or pull requests

8 participants