Giter Site home page Giter Site logo

Comments (5)

knewter avatar knewter commented on May 4, 2024

I tend to not have a separator between top-of-module and first-function, but I do have a separator between "alias, use, etc statements" and first-function. So I think my rule of thumb goes something like:

  • No newline after defmodule
  • No newline before first function def
  • Newline after "module-level-code-blocks"

from elixir_style_guide.

Kosmas avatar Kosmas commented on May 4, 2024

@knewter sounds reasonable.

I've just done a PR with your suggestions: #37

from elixir_style_guide.

asaaki avatar asaaki commented on May 4, 2024

I tend to use the same style like @knewter.

defmodule Foo do
  use SomethingElse
  alias Another.FancyModule

  def my_func do
    # ...
  end

  def another_func(true), do: 1
  def another_func(_any), do: 2

  def bar do
    # ...
  end
end

Basically reduced down to: Add empty lines between (different) functions and function calls/keywords. Don't do put a newline in the beginning or end of a module block and the first/last statement.

I still do not put an empty line between function definitions with identical arity/signature; this is still an open issue at #31.

But this is also just what I adopted from the Ruby community and their style guide.
As both languages look pretty similar it's easy to do so.

from elixir_style_guide.

knewter avatar knewter commented on May 4, 2024

Yeah, I think my biggest problem with taking my bullet list into the guide
verbatim is it's not example-y enough yet.

On Fri, Mar 6, 2015 at 10:28 AM, Christoph Grabo [email protected]
wrote:

I tend to use the same style like @knewter https://github.com/knewter.

defmodule Foo do
use SomethingElse
alias Another.FancyModule

def my_func do # ...
end

def another_func(true), do: 1
def another_func(_any), do: 2

def bar do # ...
endend

Basically reduced down to: Add empty lines between (different) functions
and function calls/keywords. Don't do put a newline in the beginning or end
of a module block and the first/last statement.

I still do not put an empty line between function definitions with
identical arity/signature; this is still an open issue at #31
#31.

But this is also just what I adopted from the Ruby community and their
style guide.
As both languages look pretty similar it's easy to do so.

โ€”
Reply to this email directly or view it on GitHub
#36 (comment)
.

Josh Adams
CTO | isotope|eleven http://www.isotope11.com
cell 215-3957
work 476-8671 x201

from elixir_style_guide.

asaaki avatar asaaki commented on May 4, 2024

I guess this issue can be closed, as the referenced PR #37 is already merged.
cc @niftyn8, @knewter

from elixir_style_guide.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.