jepler/milc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

[ci] Updated API documentation

Browse source
This commit is contained in:
Zach White 2021-08-23 16:08:54 +00:00
parent 7cfe321c88
commit 6df68ef8df
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/api__sparkline.md
View file

@ -19,14 +19,14 @@ Returns true if i is a number. Used to filter non-numbers from a list.
#### sparkline
```python
sparkline(number_list, *, min_value=None, max_value=None, highlight_threshold=inf, highlight_color='', negative_color='{fg_red}', positive_color='', highlight_reset='{fg_reset}', negative_reset='{fg_reset}', positive_reset='{fg_reset}')
sparkline(number_list, *, min_value=None, max_value=None, highlight_threshold=inf, threshold_color='', negative_color='{fg_red}', positive_color='', highlight_reset='{fg_reset}', negative_reset='{fg_reset}', positive_reset='{fg_reset}')
```
Display a sparkline from a sequence of numbers.
If you wish to exclude extreme values, or you want to limit the set of characters used, you can adjust `min_value` and `max_value` to your own values. Values between your actual min/max will exclude datapoints, while values outside your actual min/max will compress your data into fewer sparks.
If you want to highlight data that is too high you can use `highlight_threshold` to set this. Any number in your list that exceeds that threshold will be colored with `highlight_color`.
If you want to highlight data that is too high you can use `highlight_threshold` to set this. Any number in your list that exceeds that threshold will be colored with `threshold_color`.
By default this function will display negative numbers in red and positive numbers in the system default color. You can use `negative_color`, `negative_reset`, `positive_color`, and `positive_reset` to change this behavior.
@ -41,9 +41,9 @@ If you wish to color your sparkline according to other rules it is recommended t
The highest value in your sparkline. If not provided it will be determined automatically.
highlight_threshold
When a number is greater than this value it will be highlighted with `highlight_color`.
When a number is greater than this value it will be highlighted with `threshold_color`.
highlight_color
threshold_color
A MILC or ANSI color code to apply to integers greater than highlight_threshold.
negative_color
@ -53,7 +53,7 @@ If you wish to color your sparkline according to other rules it is recommended t
A MILC or ANSI color code to apply to integers greater than 0.
highlight_reset
A MILC or ANSI color code to reset the color code applied in `highlight_color`. This is usually `{fg_reset}`, `{bg_reset}`, or `{style_reset_all}`.
A MILC or ANSI color code to reset the color code applied in `threshold_color`. This is usually `{fg_reset}`, `{bg_reset}`, or `{style_reset_all}`.
negative_reset
A MILC or ANSI color code to reset the color code applied in `negative_color`. This is usually `{fg_reset}`, `{bg_reset}`, or `{style_reset_all}`.