search

AyatanaIndicators / libayatana-appindicator

Ayatana Application Indicators Shared Library
GNU Lesser General Public License v3.0
56 stars 13 forks source link

Document the status property a bit more clearly. #66

Closed WPettersson closed 1 year ago

WPettersson commented 1 year ago

Details of what each property means are taken from lines ~144-146 of app-indicator.h (search for @APP_INDICATOR_STATUS_PASSIVE).

WPettersson commented 1 year ago

Just to clarify my position, I wanted to use the attention_icon in my code, and while I could work out that I needed to set a status to use it, the generated documentation was not at all clear on what values where valid (see e.g. https://lazka.github.io/pgi-docs/AyatanaAppIndicator3-0.1/classes/Indicator.html#AyatanaAppIndicator3.Indicator.props.status). The description might already be too wordy, but at the same time it's not immediately clear from the documentation what the "type" of the status should be. I ended up working out that I had to use IndicatorStatus.ATTENTION so maybe that's also worth having in the documentation.

As an aside, is there an "official" online documentation repo?