docs icon indicating copy to clipboard operation
docs copied to clipboard

proposal: include "added in version X.X" to api docs

Open deontologician opened this issue 11 years ago • 6 comments

Right now it's difficult to know exactly which features are available based on the version of the database/drivers you're using. A lot of projects solve this by adding a note to functions to explain when they were added/modified.

deontologician avatar Sep 26 '14 19:09 deontologician

I think adding a note saying "available since X.X" would be very wise (or last updated since RethinkDB X.X).

mglukhovsky avatar Sep 26 '14 19:09 mglukhovsky

:+1:

coffeemug avatar Sep 26 '14 19:09 coffeemug

It's a bit more tricky when we change the syntax of a command or change the behavior. Like when we replace upsert with conflict in insert.

We have a page with deprecated commands (like groupedMapReduce), but we don't do versioning. We should tag the docs repo like we tag the rethinkdb repo.

neumino avatar Sep 26 '14 19:09 neumino

Yeah, this is definitely not a full solution to backwards incompatible changes. But the vast majority of changes are purely additional, and I think this helps a lot with that aspect

deontologician avatar Sep 26 '14 20:09 deontologician

I agree that we should tag the repo. We'll start doing that when we merge the website and docs repos (once the new website goes up).

mglukhovsky avatar Sep 26 '14 20:09 mglukhovsky

I'd like it if commands that received changes over time (like how changes has progressively gained the ability to be applied to more and more things) contained a "Changelog" section explaining what changed about the command's capabilities and when. This would make writing code for older environments much less fraught.

stuartpb avatar Jun 01 '15 09:06 stuartpb