https://bugs.documentfoundation.org/show_bug.cgi?id=163747
Bug ID: 163747
Summary: API documentaion: "published" decoration needs an
"unpublished" counterpart
Product: LibreOffice
Version: unspecified
Hardware: All
OS: All
Status: UNCONFIRMED
Severity: normal
Priority: medium
Component: sdk
Assignee: [email protected]
Reporter: [email protected]
CC: [email protected],
[email protected]
Ref:
https://ask.libreoffice.org/t/how-can-i-find-out-about-xselectsheetsupplier-or-what-methods-will-return-an-object-type/103621
The "published" decoration in the SDK documentation, that marks the interfaces
/ enums / services / whatever, that are actually intended for use by user,
lacks its counterpart - like "unpublished" or "internal". For a user, who
opened a given documentation page, where there's no "published" decoration,
there's no indication that this documented interface shouldn't be used in
scripts. How would one magically get that knowledge? And so, it is natural,
that people will use the unpublished parts of the API, and then suffer from
breakage. It must be expressed explicitly, and preferably not only with a short
one-word decoration, but also with some explanation, like "may change in a
future version without notice", or some such.
--
You are receiving this mail because:
You are the assignee for the bug.
