Skip to content

Commit

Permalink
Adapt to new doc structure (#1562)
Browse files Browse the repository at this point in the history
  • Loading branch information
FabienLelaquais authored Jul 22, 2024
1 parent 15de9a2 commit 4001737
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 13 deletions.
4 changes: 2 additions & 2 deletions taipy/gui/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@
add functionality to Taipy GUI:
- [`python-magic`](https://pypi.org/project/python-magic/): identifies image format
from byte buffers so the [`image`](../../../userman/gui/viselements/standard-and-blocks/image.md) control can
display them, and so that [`file_download`](../../../userman/gui/viselements/standard-and-blocks/file_download.md)
from byte buffers so the [`image`](../../../userman/gui/viselements/generic/image.md) control can
display them, and so that [`file_download`](../../../userman/gui/viselements/generic/file_download.md)
can request the browser to display the image content when relevant.<br/>
You can install that package with the regular `pip install python-magic` command
(then potentially `pip install python-magic` on Windows),
Expand Down
8 changes: 3 additions & 5 deletions taipy/gui/gui.py
Original file line number Diff line number Diff line change
Expand Up @@ -1555,7 +1555,6 @@ def broadcast_callback(
variable reflected in the user interface.
Arguments:
gui (Gui^): The current Gui instance.
callback: The user-defined function to be invoked.<br/>
The first parameter of this function must be a `State^` object representing the
client for which it is invoked.<br/>
Expand All @@ -1577,7 +1576,6 @@ def broadcast_change(self, var_name: str, value: t.Any):
instance. All user interfaces reflect the change.
Arguments:
gui (Gui^): The current Gui instance.
var_name: The name of the variable to change.
value: The new value for the variable.
"""
Expand All @@ -1600,9 +1598,9 @@ def broadcast_changes(self, values: t.Optional[dict[str, t.Any]] = None, **kwarg
values: An optional dictionary where each key is the name of a variable to change, and
where the associated value is the new value to set for that variable, in each state
for the application.
**kwargs: A collection of variable name-value pairs that are updated for each state of
the application. Name-value pairs overload the ones in *values* if the name exists
as a key in the dictionary.
**kwargs (dict[str, any]): A collection of variable name-value pairs that are updated
for each state of the application. Name-value pairs overload the ones in *values*
if the name exists as a key in the dictionary.
"""
if kwargs:
values = values.copy() if values else {}
Expand Down
4 changes: 2 additions & 2 deletions taipy/gui/icon.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
class Icon:
"""Small image in the User Interface.
Icons are typically used in controls like [button](../../userman/gui/viselements/standard-and-blocks/button.md)
or items in a [menu](../../userman/gui/viselements/standard-and-blocks/menu.md).
Icons are typically used in controls like [button](../../userman/gui/viselements/generic/button.md)
or items in a [menu](../../userman/gui/viselements/generic/menu.md).
Attributes:
path (str): The path to the image file.
Expand Down
6 changes: 3 additions & 3 deletions taipy/gui/partial.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ class Partial(_Page):
and not related pages. This allows not to have to repeat yourself when
creating your page templates.
Visual elements such as [`part`](../../userman/gui/viselements/standard-and-blocks/part.md),
[`dialog`](../..//userman/gui/viselements/standard-and-blocks/dialog.md) or
[`pane`](../../userman/gui/viselements/standard-and-blocks/pane.md) can use Partials.
Visual elements such as [`part`](../../userman/gui/viselements/generic/part.md),
[`dialog`](../..//userman/gui/viselements/generic/dialog.md) or
[`pane`](../../userman/gui/viselements/generic/pane.md) can use Partials.
Note that `Partial` has no constructor (no `__init__()` method): to create a
`Partial`, you must call the `Gui.add_partial()^` function.
Expand Down
2 changes: 1 addition & 1 deletion tools/gui/generate_pyi.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
current_version = "develop"
else:
current_version = f'release-{version.get("major", 0)}.{version.get("minor", 0)}'
taipy_doc_url = f"https://docs.taipy.io/en/{current_version}/manuals/userman/gui/viselements/standard-and-blocks/"
taipy_doc_url = f"https://docs.taipy.io/en/{current_version}/manuals/userman/gui/viselements/generic/"


# ############################################################
Expand Down

0 comments on commit 4001737

Please sign in to comment.