[elixir-core:7292] Enhancement propsal: @doc for types

[Krzysztof Wende]

Hello everyone!

This is my first proposal, but it's not huge and I believe would yield some 
positive value to the elixir community.

Every time we write bigger systems in Neon Tree Solutions Ltd we try to 
define all the specs and types to make the code look clearer.
A pattern that emerges very commonly is writing a big comment block before 
a type, to describe what it does and how it's supposed to be used.
And as elixir treats documentation as first class citizen I believe it 
would be a valuable feature to treat `@doc` blocks before types, the same 
way they are treated before functions. Right now they are just discarded 
with a warning:




I am aware that it isn't simple in terms of implementation, since a `def` 
is a macro and a type is defined with a module attribute `@type`, but I 
think it'd be worth discussing a possible ways of implementing such feature.

Plus imagine how beautiful Hex Docs would be if these gaps were filled:




Thank you for taking time discussing this topic!

Cheers


-- 
You received this message because you are subscribed to the Google Groups 
"elixir-lang-core" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to elixir-lang-core+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/elixir-lang-core/098b967e-d38c-47aa-8783-34e76bff00c0%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Re: [elixir-core:7290] Add --trace flag to mix compile

[Dmitry Belyaev]

Some compilers display a little more when --verbose is used. 

On 16 July 2017 06:53:53 GMT+10:00, "José Valim" 
 wrote:
>That always helps, so +1. The only question is if we should introduce a
>new
>flag or rather rely on MIX_DEBUG=1.
>
>
>
>*José Valim*
>www.plataformatec.com.br
>Skype: jv.ptec
>Founder and Director of R
>
>On Sat, Jul 15, 2017 at 9:41 PM, Michał Muskała 
>wrote:
>
>> Hello everybody,
>>
>> Today when something wired happens with compilation (like files
>> recompiling when they shouldn't be), it's hard to even figure out
>what
>> exactly is being compiled. I propose adding a --trace flag that would
>print
>> a bit more information. At least it would be nice to get information
>about
>> what files are being compiled, but it could also be interesting to
>see
>> something more - for example why a file is being compiled making use
>of the
>> compile-time dependancy information. This could greatly simplify
>debugging
>> compilation issues.
>>
>> Michał.
>>
>> --
>> You received this message because you are subscribed to the Google
>Groups
>> "elixir-lang-core" group.
>> To unsubscribe from this group and stop receiving emails from it,
>send an
>> email to elixir-lang-core+unsubscr...@googlegroups.com.
>> To view this discussion on the web visit https://groups.google.com/d/
>> msgid/elixir-lang-core/9e6f5eaa-2e8d-4e02-8ed1-66480609206f%40Spark
>>
>
>> .
>> For more options, visit https://groups.google.com/d/optout.
>>
>
>-- 
>You received this message because you are subscribed to the Google
>Groups "elixir-lang-core" group.
>To unsubscribe from this group and stop receiving emails from it, send
>an email to elixir-lang-core+unsubscr...@googlegroups.com.
>To view this discussion on the web visit
>https://groups.google.com/d/msgid/elixir-lang-core/CAGnRm4KBobDvRqrjLrzhbkqqxxJzU2NHJF%3D5PAf7A1X6D9Et_w%40mail.gmail.com.
>For more options, visit https://groups.google.com/d/optout.

-- 
You received this message because you are subscribed to the Google Groups 
"elixir-lang-core" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to elixir-lang-core+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/elixir-lang-core/AF647C00-8B0B-47CE-940C-78393D0786B9%40gmail.com.
For more options, visit https://groups.google.com/d/optout.