Skip to content

Commit c67e371

Browse files
committed
Fix typo
1 parent 24bd09a commit c67e371

File tree

4 files changed

+28
-29
lines changed

4 files changed

+28
-29
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PyQtDarkTheme
22

3-
PyQtDarkTheme applies a flat dark theme to QtWidgets application(PySide and PyQt). There's a light theme too. Color and style balanced from a dark theme for easy viewing in daylight.
3+
PyQtDarkTheme applies a flat dark theme to QtWidgets application. There's a light theme too. Color balanced from the dark theme for easy viewing in daylight.
44

55
Check out the [complete documentation](https://pyqtdarktheme.readthedocs.io).
66

@@ -20,7 +20,6 @@ Check out the [complete documentation](https://pyqtdarktheme.readthedocs.io).
2020

2121
- A flat dark and light theme
2222
- Support PySide and PyQt
23-
- Support PyInstaller
2423
- Sync with OS's theme and accent (Mac, Windows, Linux)
2524
- Resolve the style differences between Qt versions
2625
- Provide dark/light theme QPalette
@@ -85,7 +84,7 @@ Further information can be found in our docs:
8584
### Enable HiDPI
8685

8786
```Python
88-
# enable_hi_dpi() must be called before instantiation of QApplication.
87+
# enable_hi_dpi() must be called before the instantiation of QApplication.
8988
qdarktheme.enable_hi_dpi()
9089
app = QApplication(sys.argv)
9190
qdarktheme.setup_theme()
@@ -112,14 +111,14 @@ On macOS, qdarktheme also syncs with accent colors.
112111

113112
### Customizing colors
114113

115-
You can customize theme color.
114+
You can customize the theme color.
116115

117116
```python
118117
# Customize accent color.
119118
qdarktheme.setup_theme(custom_colors={"primary": "#D0BCFF"})
120119
```
121120

122-
Further information for customizing color can be found in our theme color docs:
121+
For a list of all customizable colors, see the Theme Color Reference:
123122

124123
- [Theme Color](https://pyqtdarktheme.readthedocs.io/en/latest/reference/theme_color.html)
125124

@@ -134,7 +133,7 @@ stylesheet = qdarktheme.setup_theme(corner_shape="sharp")
134133

135134
### QPalette and stylesheet
136135

137-
You can also only load QPalette and stylesheet. `qdarktheme.setup_theme` uses following functions internally.
136+
You can also only load QPalette and stylesheet. `qdarktheme.setup_theme` uses the following functions internally.
138137

139138
```Python
140139
palette = qdarktheme.load_palette(theme="dark")

qdarktheme/_main.py

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -93,17 +93,16 @@ def setup_theme(
9393
) -> None:
9494
"""Apply the theme which looks like flat design to the Qt App completely.
9595
96-
This function doesn't only set the Qt stylesheet,
97-
it applies the complete style to your Qt application using QPalette etc.
98-
Also if theme is ``auto``, try to listen to changes to the OS's theme and switch to a
99-
matching theme accordingly.
96+
This function applies the complete style to your Qt application. If the argument theme is ``auto``,
97+
try to listen to changes to the OS's theme and switch the application theme accordingly.
10098
10199
Args:
102100
theme: The theme name. There are `dark`, `light` and `auto`.
103-
If ``auto``, try to sync with system theme and accent(only on Mac).
104-
If failed to detect system theme, use the theme set in argument ``default_theme``.
105-
When primary color including child color(eg. ``primary>selection.background``) set to
106-
custom_colors, disable to sync with accent.
101+
If ``auto``, try to sync with your OS's theme and accent (accent is only on Mac).
102+
If failed to detect OS's theme, use the default theme set in argument ``default_theme``.
103+
When primary color(``primary``) or primary child colors
104+
(such as ``primary>selection.background``) are set to custom_colors,
105+
disable to sync with the accent.
107106
corner_shape: The corner shape. There are `rounded` and `sharp` shape.
108107
custom_colors: The custom color map. Overrides the default color for color id you set.
109108
Also you can customize a specific theme only. See example 5.

qdarktheme/_style_loader.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,10 +111,11 @@ def load_stylesheet(
111111
112112
Args:
113113
theme: The theme name. There are `dark`, `light` and `auto`.
114-
If ``auto``, try to detect system theme and accent.
115-
If failed to detect system theme, use the theme set in argument ``default_theme``.
116-
When primary color including child color(eg. ``primary>selection.background``) set to
117-
custom_colors, disable to detect accent.
114+
If ``auto``, try to detect your OS's theme and accent (accent is only on Mac).
115+
If failed to detect OS's theme, use the default theme set in argument ``default_theme``.
116+
When primary color(``primary``) or primary child colors
117+
(such as ``primary>selection.background``) are set to custom_colors,
118+
disable to detect the accent.
118119
corner_shape: The corner shape. There are `rounded` and `sharp` shape.
119120
custom_colors: The custom color map. Overrides the default color for color id you set.
120121
Also you can customize a specific theme only. See example 6.

style/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Styles
22

3-
This folder contains style data of PyQtDarkTheme. If you have a better idea for this style, edit this folder and create PR.
3+
This folder contains the style data of PyQtDarkTheme. If you have a better idea for this style, edit this folder and create PR.
44

55
## How to build style to qdarktheme module
66

@@ -10,21 +10,21 @@ You need to run the following command to add the style changes to qdarktheme.
1010
python -m tools.build_styles
1111
```
1212

13-
If you are using VSCode, you can build style and run example app at the same time by running a `Check style` task.
13+
When using VSCode, you can build the style resource and show the widget gallery together by running a "Check style" task.
1414

15-
Even if you forget to add the style changes, a pre-commit or GitHub actions will automatically build and add them.
15+
Even if you forget to add the style changes, pre-commit or GitHub actions will automatically build and add them.
1616

1717
## Colors
1818

1919
Currently, the supporting color format is only hexadecimal notations: #RGB, #RGBA, #RRGGBB, and #RRGGBBAA.
2020

2121
## Theme colors
2222

23-
Default color maps for dark/light theme is in `colors/themes/{theme_name}.json`.
23+
Default color maps for dark/light theme are in `colors/themes/{theme_name}.json`.
2424

2525
Colors that depend on specific colors like `background>textarea` adjust darkness, lightness and transparency.
2626

27-
If you think it's best to use additional theme color id for more highly customizable, you need to edit `colors/themes/{theme_name}.json` and `colors/themes/validate.json` to add color id for specific widgets or components.
27+
If you think it's best to use additional theme colors id for more highly customizable, you need to edit `colors/themes/{theme_name}.json` and `colors/themes/validate.json` to add color id for specific widgets or components.
2828

2929
## Accent colors
3030

@@ -36,22 +36,22 @@ MacOS features accent colors. qdarktheme can detect these accent colors and set
3636

3737
## Icon
3838

39-
Currently PyQtDarkTheme uses only svg icons for styling. Svg resources is in `svg/`. Most of the icons use Google [Material Design Icons](https://github.com/google/material-design-icons).
39+
Currently, PyQtDarkTheme uses only SVG for styling. All SVG icons are in `svg/`. Most of the icons use Google [Material Design Icons](https://github.com/google/material-design-icons).
4040

4141
### Material Design Icons
4242

43-
This svg icon is automatically downloaded from [material-icons](https://github.com/marella/material-icons), saved in `svg/material` and always kept up-to-date by GitHub actions. You don't need to download icons manually.
44-
If you want to add new svg of material design icons to this style, add the icon name and style to the `svg/material_design_icons.json` list.
43+
All SVG icons of Material Design Icons are automatically downloaded from [material-icons](https://github.com/marella/material-icons), saved in `svg/material`, and always kept up-to-date by GitHub actions. You don't need to download icons manually.
44+
If you want to add new material icons to this style, add the icon name and style to the `svg/material_design_icons.json` list.
4545
> **Warning**
4646
>
4747
> Don't edit `svg/material` manually.
4848
4949
### Original Icons
5050

51-
The original icons of PyQtDarkTheme is in `svg/original`. You can add and edit this icon manually.
51+
PyQtDarkTheme also has own SVG icons in `svg/original`. You can add and edit its icons manually.
5252
> **Warning**
5353
>
54-
> PyQtDarkTheme supports simple svg like following code.
54+
> PyQtDarkTheme supports simple SVG like following code.
5555
>
5656
> ```svg
5757
> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M9 16.17 5.53 12.7a.996.996 0 1 0-1.41 1.41l4.18 4.18c.39.39 1.02.39 1.41 0L20.29 7.71a.996.996 0 1 0-1.41-1.41L9 16.17z"/></svg>
@@ -61,7 +61,7 @@ The original icons of PyQtDarkTheme is in `svg/original`. You can add and edit t
6161
6262
### Override Qt standard Icons
6363
64-
Qt include [standard icons](https://doc.qt.io/qt-6/qstyle.html#StandardPixmap-enum). `qdarktheme.setup_theme` override standard icons to custom icons by using QProxyStyle. You can edit custom icons in `svg/new_standard_icons.json`.
64+
Qt has standard icons. `qdarktheme.setup_theme` can override its icons to custom icons by using QProxyStyle. You can edit custom icons in `svg/new_standard_icons.json`.
6565
6666
## Style Sheet
6767

0 commit comments

Comments
 (0)