fmt key better documentation?

The issue:

I can’t find anything in the documentation on how to format the float output of the OpenWeather widget. I tried searching for fmt everywhere but it’s just ("fmt", "{}", "How to format the text") .

Required:

• I have searched past issues to see if this bug has already been reported.

[elParaguayo]

OK, I’ll explain:

Widgets that display text typically inherit base._TextBox directly, or indirectly.

base_TextBox has a property called formatted_text which takes the text and basically does self.fmt.format(text).

The output of this property is what is displayed in the widget.

So, if you’re using, say, the OpenWeather widget and have it set up to show the temperature, leaving fmt as {} will make no difference to the output. However, if you set fmt to The temperature is: {} your widget will fill the curly brackets with the temperature.

fmt is therefore a way to add additional text, prefixes, markup etc to text based widget. It’s particularly useful on those widgets where you can’t edit the text. Take CurrentScreen for instance. That widget, by default, just shows the number of the screen. If you set fmt to Current screen: {} you now get that additional text in front of the screen number.

This allows you to add extra text to the widget without needing to use a separate TextBox widget to add more text.

[ervinpopescu]

Thanks a lot. I’d appreciate some more documentation on fmt tho 😃

I agree, but what would be a better description for it? Also, adding an example to it would probably make it way clearer.

If I knew what fmt does, I would submit a PR, not write an issue 😃