Can new features added to existing OTP api's be marked in the documentation?

Is it possible to add a “(since OTP XYZ)” for features added to existing api’s?

Library functions currently have in indication since when they are available, which is very handy if you need to support different OTP versions. What about adding those to new features. It happens to me every now an then that I use new features to api’s, which suddenly later are not available in older OTP releases.

For example: In 27 a, very handy, feature was added to binary:replace/4. It is now possible provide a replacement function, but the documentation is silent about the fact that this is a new feature. See: binary — stdlib v7.3

It would be very handy to also indicate when features have been introduced.

We try to do that as much as possible but it is easy to forget. For modules and functions we have tools that verify that we don’t miss it, but we cannot build such a tool for just documentation text.

If you find any places where it is missed, please submit a PR as I did here: os: Add since information to os:cmd/2 options by garazdawi · Pull Request #10942 · erlang/otp · GitHub

1 Like