profile.fprof mix task

[sasa1977]

Based on the discussion on the mailing list and further discussion on irc channel.

There's one known documentation issue I wasn't able to resolve (I'll add a note in the commit), but hopefully the pull's at least in the ballpark :-)

[sasa1977]

This header doesn't render properly in docs (leading spaces are dropped). Any idea how to work around this?

[josevalim]

Add a # above Total just so it is rendered properly then. :)

[sasa1977]

Not sure what you mean. Adding a # right above T preserves the spaces, but the # is visible and the line is rendered as a comment:

As a trick, I was thinking maybe adding a caption to the column, e.g. TITLE, or NAME, or something similar. Then the header starts at column 1, and we have no problems.

[ericmj]

You can do a proper markdown table, check Kernel.Typespec for examples.

[sasa1977]

A table is an interesting workaround, although I'd prefer to have it as a standard code snippet (pre element) since this is the output of the task. But yeah, that might be one way of dealing with it. I could say, "The task produces the following table:" or something similar.

[josevalim]

Just add the # at the top or any other character. We don't need to perfectly reflect the table, anything that looks sufficiently nice, will suffice.

[josevalim]

Btw, the docs here are fantastic.

[josevalim]

This is beautiful, thank you. Just a heads up, it will take some time for me to get back to you. I am likely not putting any dev cycles on Elixir in June (trying to get Plug+Ecto as 1.0 out).

[sasa1977]

No hurry. Do you have any idea though why travis would fail on the unrelated code with +T 9 option set?

[ericmj]

Travis failure is an unrelated race condition.

[sasa1977]

Travis failure is an unrelated race condition.

I suspected as much. Should I just restart the build then?

[sasa1977]

I fixed the doc table layout by using a fake space (see 08031e9). It looks ok both in web docs and terminal (mix help).

[ericmj]

Although a nice hack and a good idea I don't think we should use NBSP. It's easy to accidentally break in the future and you don't know you broke until you look at the generated docs.

[josevalim]

Yeah, what @ericmj said. :)

[sasa1977]

So it's a # then?

[josevalim]

Yeah, or anything simple like it.

José Valimwww.plataformatec.com.br
http://www.plataformatec.com.br/Founder and Lead Developer

[sasa1977]

OK, I pushed the # char. Once you're ok with the complete feature, and before the merge, I could rebase/squash these commits to keep the history clean. No rush with merging, as far as I'm concerned.

[josevalim]

❤️ 💚 💙 💛 💜