Skip to content

Add docs for symbol option of PercentType #10464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Add docs for symbol option of PercentType #10464

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e567e9e
Add docs for symbol option of PercentType
Oct 9, 2018
16080ca
Address title underline being too short #10464
Oct 9, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion reference/forms/types/percent.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,13 @@ percentage data. If your percentage data is stored as a decimal (e.g. ``.95``),
you can use this field out-of-the-box. If you store your data as a number
(e.g. ``95``), you should set the ``type`` option to ``integer``.

This field adds a percentage sign "``%``" after the input box.
When ``symbol`` is true, the field will add a percentage sign "``%``" after the input box.

+-------------+-----------------------------------------------------------------------+
| Rendered as | ``input`` ``text`` field |
+-------------+-----------------------------------------------------------------------+
| Options | - `scale`_ |
| | - `symbol`_ |
| | - `type`_ |
+-------------+-----------------------------------------------------------------------+
| Overridden | - `compound`_ |
Expand Down Expand Up @@ -50,6 +51,15 @@ scale
By default, the input numbers are rounded. To allow for more decimal places,
use this option.

symbol
~~~~~~

**type**: ``boolean`` **default**: ``true``

By default, fields are rendered with a percentage sign "`%`" after the input
box. Setting this value to ``false`` will disable the percentage sign from
Copy link
Contributor

@OskarStark OskarStark Oct 10, 2018 •
edited by javiereguiluz
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

- will disable the percentage sign from being displayed.
+ will not show the percentage sign.

what do you think? Much simpler to read/understand

being displayed.

type
~~~~

Expand Down