Re: libosmocore[master]: doc: fix incorrect return value description
On Wed, May 10, 2017 at 12:43:42PM +0000, Max wrote:
To view, visit https://gerrit.osmocom.org/2552
Patch Set 1:
I guess this could use an entry in 'TODO-RELEASE' to note the fixed API?
Why? TODO-RELEASE is for keeping track of API/ABI changes so we bump corresponding versions when necessary. Docstring change requires neither API not ABI bump.
In my view the API doc describes how the API/ABI *should* behave, and if it mismatches that's like a bug in the API. If we fix that bug, that's interesting for users of the API, right? ~N
On 11.05.2017 14:49, Neels Hofmeyr wrote:
On Wed, May 10, 2017 at 12:43:42PM +0000, Max wrote:
To view, visit https://gerrit.osmocom.org/2552
Patch Set 1:
I guess this could use an entry in 'TODO-RELEASE' to note the fixed API? Why? TODO-RELEASE is for keeping track of API/ABI changes so we bump corresponding versions when necessary. Docstring change requires neither API not ABI bump. In my view the API doc describes how the API/ABI *should* behave, and if it mismatches that's like a bug in the API. If we fix that bug, that's interesting for users of the API, right?
Except that it's not - wrong documentation for API is bug in the documentation, not API. It might be interesting for API users but this have nothing to do with (no pun intended) TODO-RELEASE file was never targeted for API users. -- Max Suraev <msuraev@sysmocom.de> http://www.sysmocom.de/ ======================================================================= * sysmocom - systems for mobile communications GmbH * Alt-Moabit 93 * 10559 Berlin, Germany * Sitz / Registered office: Berlin, HRB 134158 B * Geschaeftsfuehrer / Managing Director: Harald Welte
On Thu, May 11, 2017 at 02:54:56PM +0200, Max wrote:
Except that it's not - wrong documentation for API is bug in the documentation, not API. It might be interesting for API users but this have nothing to do with (no pun intended) TODO-RELEASE file was never targeted for API users.
I still don't see your point. If not the API, what else do I use of libosmocore? If I implement code, I look at the API doc. If that had an error, it's a significant change towards users, no matter what you intend. I'll stop reiterating the same point over and over now. I wish you were less rigid on this. ~N
participants (2)
-
Max -
Neels Hofmeyr