Add OTP versions in docs for "new" functions and modules#2044
Conversation
|
Nice! That's useful. Orange though? |
|
@essen Maybe green is nicer, same color as the "Note" boxes. |
It does! Perhaps a bit too much.
I'm sure @marianoguerra will want to pitch in. :-) |
|
That's a great addition overall. It will make it simpler when working on libraries that need to support older versions. For reference this is how similar information is displayed in the Elixir docs: https://hexdocs.pm/elixir/Date.html#add/2 |
|
Looks good! Maybe for recent releases (2?) it has a more prominent color, since you should consider the compatibility implications of using it for older releases it gets a softer color like grey, since it should be OK to use them, and someone who has to support older versions knows where to look. |
|
The actual layout in the generated html is not in place yet. And is open for comments. A modified version is under construction. |
|
Orange color should be used for deprecated functions and modules, maybe? |
|
Now a more discreet look. |
|
Looks good! |
'*' is part of the return type, not the function name.
for <func><name> and <module> with "since" attribute.
introduced after OTP_R13B03.
sverker
force-pushed
the
sverker/add-since-doc/OTP-15460
branch
from
7525fa0 to
20cc39d
Compare
sverker
added
testing
The ones marked since="?" are unknown (but newer than R13B03) monitor/2 port_info/2 process_flag/2 statistics/1 system_flag/2 system_info/1 trace_pattern/3
6 participants
The reference documentation will tell in which OTP version a function or module was first introduced.
For entire new modules, a "Since" headline is added at the top. Example:
http://erlang.org/~sverker/since/lib/stdlib-3.6/doc/html/rand.html
For functions, an OTP version is shown in the right margin. Example:
http://erlang.org/~sverker/since/erts-10.1.3/doc/html/erlang.html
(search for "OTP" a couple of times)
OTP versions older than R13B04 will not be shown.
You can browse all modules here:
http://erlang.org/~sverker/since/doc/man_index.html