diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 023bc14284..4654bbb76a 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -62,7 +62,7 @@ repos: - id: check-added-large-files - id: mixed-line-ending - repo: https://github.com/psf/black - rev: 1b2427a2b785cc4aac97c19bb4b9a0de063f9547 # frozen: 24.10.0 + rev: 8a737e727ac5ab2f1d4cf5876720ed276dc8dc4b # frozen: 25.1.0 hooks: - id: black args: ['--line-length', '100'] diff --git a/src/Mod/AddonManager/Addon.py b/src/Mod/AddonManager/Addon.py index 7266dba998..d028429689 100644 --- a/src/Mod/AddonManager/Addon.py +++ b/src/Mod/AddonManager/Addon.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Defines the Addon class to encapsulate information about FreeCAD Addons """ +"""Defines the Addon class to encapsulate information about FreeCAD Addons""" import os import re diff --git a/src/Mod/AddonManager/AddonManagerOptions.py b/src/Mod/AddonManager/AddonManagerOptions.py index 4b1d7e2300..783f1a733a 100644 --- a/src/Mod/AddonManager/AddonManagerOptions.py +++ b/src/Mod/AddonManager/AddonManagerOptions.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Contains a the Addon Manager's preferences dialog management class """ +"""Contains a the Addon Manager's preferences dialog management class""" import os diff --git a/src/Mod/AddonManager/AddonStats.py b/src/Mod/AddonManager/AddonStats.py index 60c329dcc8..4cf7b319ac 100644 --- a/src/Mod/AddonManager/AddonStats.py +++ b/src/Mod/AddonManager/AddonStats.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Classes and structures related to Addon sidecar information """ +"""Classes and structures related to Addon sidecar information""" from __future__ import annotations from dataclasses import dataclass diff --git a/src/Mod/AddonManager/Widgets/addonmanager_widget_addon_buttons.py b/src/Mod/AddonManager/Widgets/addonmanager_widget_addon_buttons.py index 8c65c5998c..e5ffc3fdc1 100644 --- a/src/Mod/AddonManager/Widgets/addonmanager_widget_addon_buttons.py +++ b/src/Mod/AddonManager/Widgets/addonmanager_widget_addon_buttons.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Defines a QWidget-derived class for displaying the single-addon buttons. """ +"""Defines a QWidget-derived class for displaying the single-addon buttons.""" from enum import Enum, auto diff --git a/src/Mod/AddonManager/Widgets/addonmanager_widget_filter_selector.py b/src/Mod/AddonManager/Widgets/addonmanager_widget_filter_selector.py index a8fb528dc4..308335e3c9 100644 --- a/src/Mod/AddonManager/Widgets/addonmanager_widget_filter_selector.py +++ b/src/Mod/AddonManager/Widgets/addonmanager_widget_filter_selector.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Defines a QWidget-derived class for displaying the view selection buttons. """ +"""Defines a QWidget-derived class for displaying the view selection buttons.""" from enum import IntEnum diff --git a/src/Mod/AddonManager/Widgets/addonmanager_widget_global_buttons.py b/src/Mod/AddonManager/Widgets/addonmanager_widget_global_buttons.py index cce7336890..67833201bd 100644 --- a/src/Mod/AddonManager/Widgets/addonmanager_widget_global_buttons.py +++ b/src/Mod/AddonManager/Widgets/addonmanager_widget_global_buttons.py @@ -21,9 +21,9 @@ # * * # *************************************************************************** -""" Defines a QWidget-derived class for displaying a set of buttons that affect the Addon +"""Defines a QWidget-derived class for displaying a set of buttons that affect the Addon Manager as a whole (rather than a specific Addon). Typically inserted at the bottom of the Addon -Manager main window. """ +Manager main window.""" try: import FreeCAD diff --git a/src/Mod/AddonManager/Widgets/addonmanager_widget_progress_bar.py b/src/Mod/AddonManager/Widgets/addonmanager_widget_progress_bar.py index 2e069a5baf..1e9c0a1f20 100644 --- a/src/Mod/AddonManager/Widgets/addonmanager_widget_progress_bar.py +++ b/src/Mod/AddonManager/Widgets/addonmanager_widget_progress_bar.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Defines a QWidget-derived class for displaying the cache load status. """ +"""Defines a QWidget-derived class for displaying the cache load status.""" try: import FreeCAD diff --git a/src/Mod/AddonManager/Widgets/addonmanager_widget_search.py b/src/Mod/AddonManager/Widgets/addonmanager_widget_search.py index 7da8b1c271..339f31fcdf 100644 --- a/src/Mod/AddonManager/Widgets/addonmanager_widget_search.py +++ b/src/Mod/AddonManager/Widgets/addonmanager_widget_search.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Defines a QWidget-derived class for displaying the view selection buttons. """ +"""Defines a QWidget-derived class for displaying the view selection buttons.""" try: import FreeCAD diff --git a/src/Mod/AddonManager/Widgets/addonmanager_widget_view_control_bar.py b/src/Mod/AddonManager/Widgets/addonmanager_widget_view_control_bar.py index 9343b030e1..3d44a18954 100644 --- a/src/Mod/AddonManager/Widgets/addonmanager_widget_view_control_bar.py +++ b/src/Mod/AddonManager/Widgets/addonmanager_widget_view_control_bar.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Defines a class derived from QWidget for displaying the bar at the top of the addons list. """ +"""Defines a class derived from QWidget for displaying the bar at the top of the addons list.""" from enum import IntEnum, auto diff --git a/src/Mod/AddonManager/Widgets/addonmanager_widget_view_selector.py b/src/Mod/AddonManager/Widgets/addonmanager_widget_view_selector.py index 3049d23194..7a65a0f655 100644 --- a/src/Mod/AddonManager/Widgets/addonmanager_widget_view_selector.py +++ b/src/Mod/AddonManager/Widgets/addonmanager_widget_view_selector.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Defines a QWidget-derived class for displaying the view selection buttons. """ +"""Defines a QWidget-derived class for displaying the view selection buttons.""" from enum import IntEnum diff --git a/src/Mod/AddonManager/addonmanager_connection_checker.py b/src/Mod/AddonManager/addonmanager_connection_checker.py index ac3c08aa14..1b721ce761 100644 --- a/src/Mod/AddonManager/addonmanager_connection_checker.py +++ b/src/Mod/AddonManager/addonmanager_connection_checker.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" System for checking the network connection status asynchronously. """ +"""System for checking the network connection status asynchronously.""" import FreeCAD diff --git a/src/Mod/AddonManager/addonmanager_devmode.py b/src/Mod/AddonManager/addonmanager_devmode.py index 860b9ab934..4888ae6076 100644 --- a/src/Mod/AddonManager/addonmanager_devmode.py +++ b/src/Mod/AddonManager/addonmanager_devmode.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Classes to manage "Developer Mode" """ +"""Classes to manage "Developer Mode" """ import os import datetime diff --git a/src/Mod/AddonManager/addonmanager_devmode_add_content.py b/src/Mod/AddonManager/addonmanager_devmode_add_content.py index c5994ccbab..f990f643ec 100644 --- a/src/Mod/AddonManager/addonmanager_devmode_add_content.py +++ b/src/Mod/AddonManager/addonmanager_devmode_add_content.py @@ -21,8 +21,8 @@ # * * # *************************************************************************** -""" Contains a class for adding a single content item, as well as auxiliary classes for -its dependent dialog boxes. """ +"""Contains a class for adding a single content item, as well as auxiliary classes for +its dependent dialog boxes.""" import os from typing import Optional, Tuple, List diff --git a/src/Mod/AddonManager/addonmanager_devmode_license_selector.py b/src/Mod/AddonManager/addonmanager_devmode_license_selector.py index 72db565694..2e6441d9f8 100644 --- a/src/Mod/AddonManager/addonmanager_devmode_license_selector.py +++ b/src/Mod/AddonManager/addonmanager_devmode_license_selector.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Contains a class to manage selection of a license for an Addon. """ +"""Contains a class to manage selection of a license for an Addon.""" import os from datetime import date diff --git a/src/Mod/AddonManager/addonmanager_devmode_licenses_table.py b/src/Mod/AddonManager/addonmanager_devmode_licenses_table.py index 1d52568471..26e29c434c 100644 --- a/src/Mod/AddonManager/addonmanager_devmode_licenses_table.py +++ b/src/Mod/AddonManager/addonmanager_devmode_licenses_table.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Contains a wrapper class for a table listing authors and maintainers """ +"""Contains a wrapper class for a table listing authors and maintainers""" import os diff --git a/src/Mod/AddonManager/addonmanager_devmode_metadata_checker.py b/src/Mod/AddonManager/addonmanager_devmode_metadata_checker.py index d1ec922836..efae4ab928 100644 --- a/src/Mod/AddonManager/addonmanager_devmode_metadata_checker.py +++ b/src/Mod/AddonManager/addonmanager_devmode_metadata_checker.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Metadata validation functions """ +"""Metadata validation functions""" from typing import List diff --git a/src/Mod/AddonManager/addonmanager_devmode_people_table.py b/src/Mod/AddonManager/addonmanager_devmode_people_table.py index e6caca269a..048100bff4 100644 --- a/src/Mod/AddonManager/addonmanager_devmode_people_table.py +++ b/src/Mod/AddonManager/addonmanager_devmode_people_table.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Contains a wrapper class for a table listing authors and maintainers """ +"""Contains a wrapper class for a table listing authors and maintainers""" import os diff --git a/src/Mod/AddonManager/addonmanager_devmode_person_editor.py b/src/Mod/AddonManager/addonmanager_devmode_person_editor.py index 4c1fbda24c..12f5d2a31a 100644 --- a/src/Mod/AddonManager/addonmanager_devmode_person_editor.py +++ b/src/Mod/AddonManager/addonmanager_devmode_person_editor.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Contains a class to handle editing a person (from a Metadata standpoint). """ +"""Contains a class to handle editing a person (from a Metadata standpoint).""" import os from typing import Tuple # Needed until Py 3.9, when tuple supports this directly diff --git a/src/Mod/AddonManager/addonmanager_devmode_predictor.py b/src/Mod/AddonManager/addonmanager_devmode_predictor.py index 278ada4e87..012e0eb6c5 100644 --- a/src/Mod/AddonManager/addonmanager_devmode_predictor.py +++ b/src/Mod/AddonManager/addonmanager_devmode_predictor.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Class to guess metadata based on folder contents. Note that one of the functions +"""Class to guess metadata based on folder contents. Note that one of the functions of this file is to guess the license being applied to the new software package based in its contents. It is up to the user to make the final determination about whether the selected license is the correct one, and inclusion here shouldn't be construed as diff --git a/src/Mod/AddonManager/addonmanager_devmode_validators.py b/src/Mod/AddonManager/addonmanager_devmode_validators.py index 000f2aaefc..c4c7e71fda 100644 --- a/src/Mod/AddonManager/addonmanager_devmode_validators.py +++ b/src/Mod/AddonManager/addonmanager_devmode_validators.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Validators used for various line edits """ +"""Validators used for various line edits""" import keyword diff --git a/src/Mod/AddonManager/addonmanager_firstrun.py b/src/Mod/AddonManager/addonmanager_firstrun.py index 2fc9f8a3b1..2b8cbeb378 100644 --- a/src/Mod/AddonManager/addonmanager_firstrun.py +++ b/src/Mod/AddonManager/addonmanager_firstrun.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Class to display a first-run dialog for the Addon Manager """ +"""Class to display a first-run dialog for the Addon Manager""" import os diff --git a/src/Mod/AddonManager/addonmanager_installer.py b/src/Mod/AddonManager/addonmanager_installer.py index d3f2f7de1b..059f0fc0c1 100644 --- a/src/Mod/AddonManager/addonmanager_installer.py +++ b/src/Mod/AddonManager/addonmanager_installer.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Contains the classes to manage Addon installation: intended as a stable API, safe for external +"""Contains the classes to manage Addon installation: intended as a stable API, safe for external code to call and to rely upon existing. See classes AddonInstaller and MacroInstaller for details. """ import json diff --git a/src/Mod/AddonManager/addonmanager_licenses.py b/src/Mod/AddonManager/addonmanager_licenses.py index 5781c093a2..46af254959 100644 --- a/src/Mod/AddonManager/addonmanager_licenses.py +++ b/src/Mod/AddonManager/addonmanager_licenses.py @@ -21,9 +21,9 @@ # * * # *************************************************************************** -""" Utilities for working with licenses. Based on SPDX info downloaded from +"""Utilities for working with licenses. Based on SPDX info downloaded from https://github.com/spdx/license-list-data and stored as part of the FreeCAD repo, loaded into a Qt -resource. """ +resource.""" import json diff --git a/src/Mod/AddonManager/addonmanager_macro.py b/src/Mod/AddonManager/addonmanager_macro.py index 2af34c7b2c..9858076f9c 100644 --- a/src/Mod/AddonManager/addonmanager_macro.py +++ b/src/Mod/AddonManager/addonmanager_macro.py @@ -22,7 +22,7 @@ # * * # *************************************************************************** -""" Unified handler for FreeCAD macros that can be obtained from different sources. """ +"""Unified handler for FreeCAD macros that can be obtained from different sources.""" import os import re diff --git a/src/Mod/AddonManager/addonmanager_python_deps_gui.py b/src/Mod/AddonManager/addonmanager_python_deps_gui.py index 73e0ffc244..8123ef9930 100644 --- a/src/Mod/AddonManager/addonmanager_python_deps_gui.py +++ b/src/Mod/AddonManager/addonmanager_python_deps_gui.py @@ -21,9 +21,9 @@ # * * # *************************************************************************** -""" Provides classes and support functions for managing the automatically-installed +"""Provides classes and support functions for managing the automatically-installed Python library dependencies. No support is provided for uninstalling those dependencies -because pip's uninstall function does not support the target directory argument. """ +because pip's uninstall function does not support the target directory argument.""" import json import os diff --git a/src/Mod/AddonManager/addonmanager_readme_controller.py b/src/Mod/AddonManager/addonmanager_readme_controller.py index 7507db4afd..d7b1624a9f 100644 --- a/src/Mod/AddonManager/addonmanager_readme_controller.py +++ b/src/Mod/AddonManager/addonmanager_readme_controller.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" A Qt Widget for displaying Addon README information """ +"""A Qt Widget for displaying Addon README information""" import FreeCAD from Addon import Addon diff --git a/src/Mod/AddonManager/addonmanager_uninstaller.py b/src/Mod/AddonManager/addonmanager_uninstaller.py index bf709f9172..448031e890 100644 --- a/src/Mod/AddonManager/addonmanager_uninstaller.py +++ b/src/Mod/AddonManager/addonmanager_uninstaller.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Contains the classes to manage Addon removal: intended as a stable API, safe for +"""Contains the classes to manage Addon removal: intended as a stable API, safe for external code to call and to rely upon existing. See classes AddonUninstaller and MacroUninstaller for details.""" import json diff --git a/src/Mod/AddonManager/addonmanager_utilities.py b/src/Mod/AddonManager/addonmanager_utilities.py index 837dbc4917..5a95d60229 100644 --- a/src/Mod/AddonManager/addonmanager_utilities.py +++ b/src/Mod/AddonManager/addonmanager_utilities.py @@ -22,7 +22,7 @@ # * * # *************************************************************************** -""" Utilities to work across different platforms, providers and python versions """ +"""Utilities to work across different platforms, providers and python versions""" from datetime import datetime from typing import Optional, Any, List diff --git a/src/Mod/AddonManager/addonmanager_workers_installation.py b/src/Mod/AddonManager/addonmanager_workers_installation.py index ff3e063ece..635b2650ab 100644 --- a/src/Mod/AddonManager/addonmanager_workers_installation.py +++ b/src/Mod/AddonManager/addonmanager_workers_installation.py @@ -22,7 +22,7 @@ # * * # *************************************************************************** -""" Worker thread classes for Addon Manager installation and removal """ +"""Worker thread classes for Addon Manager installation and removal""" # pylint: disable=c-extension-no-member,too-few-public-methods,too-many-instance-attributes diff --git a/src/Mod/AddonManager/addonmanager_workers_startup.py b/src/Mod/AddonManager/addonmanager_workers_startup.py index c84b226c6a..3b0bf82b10 100644 --- a/src/Mod/AddonManager/addonmanager_workers_startup.py +++ b/src/Mod/AddonManager/addonmanager_workers_startup.py @@ -22,7 +22,7 @@ # * * # *************************************************************************** -""" Worker thread classes for Addon Manager startup """ +"""Worker thread classes for Addon Manager startup""" import hashlib import json import os diff --git a/src/Mod/AddonManager/addonmanager_workers_utility.py b/src/Mod/AddonManager/addonmanager_workers_utility.py index 48b8d360bd..5c8aa1b538 100644 --- a/src/Mod/AddonManager/addonmanager_workers_utility.py +++ b/src/Mod/AddonManager/addonmanager_workers_utility.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Misc. worker thread classes for the FreeCAD Addon Manager. """ +"""Misc. worker thread classes for the FreeCAD Addon Manager.""" from typing import Optional diff --git a/src/Mod/AddonManager/composite_view.py b/src/Mod/AddonManager/composite_view.py index d9c429d5df..c20a724225 100644 --- a/src/Mod/AddonManager/composite_view.py +++ b/src/Mod/AddonManager/composite_view.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Provides a class for showing the list view and detail view at the same time. """ +"""Provides a class for showing the list view and detail view at the same time.""" import base64 diff --git a/src/Mod/AddonManager/install_to_toolbar.py b/src/Mod/AddonManager/install_to_toolbar.py index c40af1bf39..9f3ba038b8 100644 --- a/src/Mod/AddonManager/install_to_toolbar.py +++ b/src/Mod/AddonManager/install_to_toolbar.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" A collection of functions to handle installing a macro icon to the toolbar. """ +"""A collection of functions to handle installing a macro icon to the toolbar.""" import os diff --git a/src/Mod/AddonManager/package_list.py b/src/Mod/AddonManager/package_list.py index 921337af50..b4590b776f 100644 --- a/src/Mod/AddonManager/package_list.py +++ b/src/Mod/AddonManager/package_list.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -""" Defines the PackageList QWidget for displaying a list of Addons. """ +"""Defines the PackageList QWidget for displaying a list of Addons.""" import datetime import threading diff --git a/src/Mod/CAM/Path/Main/Gui/Fixture.py b/src/Mod/CAM/Path/Main/Gui/Fixture.py index e701db08f5..51f4644330 100644 --- a/src/Mod/CAM/Path/Main/Gui/Fixture.py +++ b/src/Mod/CAM/Path/Main/Gui/Fixture.py @@ -20,7 +20,7 @@ # * * # *************************************************************************** -""" Used to create CNC machine fixture offsets such as G54,G55, etc...""" +"""Used to create CNC machine fixture offsets such as G54,G55, etc...""" import FreeCAD import FreeCADGui diff --git a/src/Mod/CAM/Path/Op/Gui/Selection.py b/src/Mod/CAM/Path/Op/Gui/Selection.py index 547a6521e4..ff0e033a02 100644 --- a/src/Mod/CAM/Path/Op/Gui/Selection.py +++ b/src/Mod/CAM/Path/Op/Gui/Selection.py @@ -21,7 +21,7 @@ # * * # *************************************************************************** -"""Selection gates and observers to control selectability while building Path operations """ +"""Selection gates and observers to control selectability while building Path operations""" import FreeCAD import FreeCADGui diff --git a/src/Mod/CAM/Path/Post/Command.py b/src/Mod/CAM/Path/Post/Command.py index 9fa9be28c1..275052860b 100644 --- a/src/Mod/CAM/Path/Post/Command.py +++ b/src/Mod/CAM/Path/Post/Command.py @@ -21,7 +21,7 @@ # *************************************************************************** """Post Process command that will make use of the Output File and Post -Processor entries in PathJob """ +Processor entries in PathJob""" import FreeCAD diff --git a/src/Mod/CAM/PathScripts/PathUtils.py b/src/Mod/CAM/PathScripts/PathUtils.py index 0b48c04b1e..10a846456c 100644 --- a/src/Mod/CAM/PathScripts/PathUtils.py +++ b/src/Mod/CAM/PathScripts/PathUtils.py @@ -19,7 +19,7 @@ # * USA * # * * # *************************************************************************** -"""PathUtils -common functions used in PathScripts for filtering, sorting, and generating gcode toolpath data """ +"""PathUtils -common functions used in PathScripts for filtering, sorting, and generating gcode toolpath data""" import FreeCAD from FreeCAD import Vector diff --git a/src/Mod/Fem/femguiutils/migrate_gui.py b/src/Mod/Fem/femguiutils/migrate_gui.py index 709f5bc829..bd7f7a8024 100644 --- a/src/Mod/Fem/femguiutils/migrate_gui.py +++ b/src/Mod/Fem/femguiutils/migrate_gui.py @@ -20,7 +20,7 @@ # * USA * # * * # *************************************************************************** -""" Class and methods to migrate old FEM Gui objects +"""Class and methods to migrate old FEM Gui objects see module end as well as forum topic https://forum.freecad.org/viewtopic.php?&t=46218 diff --git a/src/Mod/Fem/femsolver/run.py b/src/Mod/Fem/femsolver/run.py index 1678f52ced..d3fcb18f4e 100644 --- a/src/Mod/Fem/femsolver/run.py +++ b/src/Mod/Fem/femsolver/run.py @@ -21,7 +21,7 @@ # * USA * # * * # *************************************************************************** -""" Execute Solver and obtain Reports and Results. +"""Execute Solver and obtain Reports and Results. Integral part of the Solver Framework which contains components responsible for executing the solver in the background. Also provides an asynchronous diff --git a/src/Mod/Fem/femsolver/settings.py b/src/Mod/Fem/femsolver/settings.py index 57d9319a33..c9af5eb92d 100644 --- a/src/Mod/Fem/femsolver/settings.py +++ b/src/Mod/Fem/femsolver/settings.py @@ -21,7 +21,7 @@ # * USA * # * * # *************************************************************************** -""" Query FEM specific settings including solver settings. +"""Query FEM specific settings including solver settings. Query settings from the hierarchically organized settings/parameter system of FreeCAD related to the FEM module. The collection of independent functions use diff --git a/src/Mod/Fem/femtools/constants.py b/src/Mod/Fem/femtools/constants.py index 1964fd317a..ac2e29d9e0 100644 --- a/src/Mod/Fem/femtools/constants.py +++ b/src/Mod/Fem/femtools/constants.py @@ -20,7 +20,7 @@ # * USA * # * * # *************************************************************************** -""" Collection of natural constants for the Fem module. +"""Collection of natural constants for the Fem module. This module contains natural constants for the Fem module. All constants are in SI units. diff --git a/src/Mod/Fem/femtools/femutils.py b/src/Mod/Fem/femtools/femutils.py index af96a46be6..baa22be276 100644 --- a/src/Mod/Fem/femtools/femutils.py +++ b/src/Mod/Fem/femtools/femutils.py @@ -22,7 +22,7 @@ # * USA * # * * # *************************************************************************** -""" Collection of functions for the Fem module. +"""Collection of functions for the Fem module. This module contains function for extracting relevant parts of geometry and a few unrelated function useful at various places in the Fem module. diff --git a/src/Mod/Fem/femtools/membertools.py b/src/Mod/Fem/femtools/membertools.py index 44fbfd5340..48d97c162a 100644 --- a/src/Mod/Fem/femtools/membertools.py +++ b/src/Mod/Fem/femtools/membertools.py @@ -21,7 +21,7 @@ # * USA * # * * # *************************************************************************** -""" Collection of functions for the Fem module. +"""Collection of functions for the Fem module. This module contains function for managing a analysis and all the different types of objects it contains, helper for executing a simulation. diff --git a/src/Mod/Fem/femtools/migrate_app.py b/src/Mod/Fem/femtools/migrate_app.py index 902fcbcc2c..8b97e5b1ce 100644 --- a/src/Mod/Fem/femtools/migrate_app.py +++ b/src/Mod/Fem/femtools/migrate_app.py @@ -20,7 +20,7 @@ # * USA * # * * # *************************************************************************** -""" Class and methods to migrate old FEM App objects +"""Class and methods to migrate old FEM App objects see module end as well as forum topic https://forum.freecad.org/viewtopic.php?&t=46218 diff --git a/src/Mod/Mesh/BuildRegularGeoms.py b/src/Mod/Mesh/BuildRegularGeoms.py index 4be4b09cfe..ef34996c5e 100644 --- a/src/Mod/Mesh/BuildRegularGeoms.py +++ b/src/Mod/Mesh/BuildRegularGeoms.py @@ -7,9 +7,9 @@ Return value are list of vectors, 3 vectors define a facet. Sample code for creating a mesh: - facets = Cube(3.0, 4.0, 5.0) - m = Mesh.newMesh() - m.addFacets(facets) + facets = Cube(3.0, 4.0, 5.0) + m = Mesh.newMesh() + m.addFacets(facets) """ diff --git a/src/Mod/MeshPart/InitGui.py b/src/Mod/MeshPart/InitGui.py index c4cea6af20..38cee8a100 100644 --- a/src/Mod/MeshPart/InitGui.py +++ b/src/Mod/MeshPart/InitGui.py @@ -31,6 +31,7 @@ class MeshPartWorkbench(Workbench): "MeshPart workbench object" + Icon = """ /* XPM */ static const char *MeshPart_Box[]={ diff --git a/src/Mod/Test/GuiDocument.py b/src/Mod/Test/GuiDocument.py index f5980e959b..595a131001 100644 --- a/src/Mod/Test/GuiDocument.py +++ b/src/Mod/Test/GuiDocument.py @@ -1,25 +1,25 @@ # SPDX-License-Identifier: LGPL-2.1-or-later """************************************************************************** - * * - * Copyright (c) 2024 Ondsel * - * * - * This file is part of FreeCAD. * - * * - * FreeCAD is free software: you can redistribute it and/or modify it * - * under the terms of the GNU Lesser General Public License as * - * published by the Free Software Foundation, either version 2.1 of the * - * License, or (at your option) any later version. * - * * - * FreeCAD is distributed in the hope that it will be useful, but * - * WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * - * Lesser General Public License for more details. * - * * - * You should have received a copy of the GNU Lesser General Public * - * License along with FreeCAD. If not, see * - * . * - * * - ***************************************************************************/""" +* * +* Copyright (c) 2024 Ondsel * +* * +* This file is part of FreeCAD. * +* * +* FreeCAD is free software: you can redistribute it and/or modify it * +* under the terms of the GNU Lesser General Public License as * +* published by the Free Software Foundation, either version 2.1 of the * +* License, or (at your option) any later version. * +* * +* FreeCAD is distributed in the hope that it will be useful, but * +* WITHOUT ANY WARRANTY; without even the implied warranty of * +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * +* Lesser General Public License for more details. * +* * +* You should have received a copy of the GNU Lesser General Public * +* License along with FreeCAD. If not, see * +* . * +* * +***************************************************************************/""" import FreeCAD, FreeCADGui, unittest diff --git a/src/Tools/_TEMPLATEPY_/InitGui.py b/src/Tools/_TEMPLATEPY_/InitGui.py index b6721b7f85..c99dce969e 100644 --- a/src/Tools/_TEMPLATEPY_/InitGui.py +++ b/src/Tools/_TEMPLATEPY_/InitGui.py @@ -6,6 +6,7 @@ class _TEMPLATEPY_Workbench(Workbench): "_TEMPLATEPY_ workbench object" + Icon = FreeCAD.getResourceDir() + "Mod/_TEMPLATEPY_/Resources/icons/_TEMPLATEPY_Workbench.svg" MenuText = "_TEMPLATEPY_" ToolTip = "_TEMPLATEPY_ workbench" diff --git a/src/Tools/_TEMPLATE_/InitGui.py b/src/Tools/_TEMPLATE_/InitGui.py index 6ebe346b82..b1f37f69ef 100644 --- a/src/Tools/_TEMPLATE_/InitGui.py +++ b/src/Tools/_TEMPLATE_/InitGui.py @@ -4,6 +4,7 @@ class _TEMPLATE_Workbench(Workbench): "_TEMPLATE_ workbench object" + MenuText = "_TEMPLATE_" ToolTip = "_TEMPLATE_ workbench" diff --git a/src/Tools/updatecrowdin.py b/src/Tools/updatecrowdin.py index f7b601e91c..79a4520ad1 100755 --- a/src/Tools/updatecrowdin.py +++ b/src/Tools/updatecrowdin.py @@ -341,7 +341,6 @@ def load_token(): def updateqrc(qrcpath, lncode): - "updates a qrc file with the given translation entry" # print("opening " + qrcpath + "...") @@ -398,7 +397,6 @@ def updateqrc(qrcpath, lncode): def updateTranslatorCpp(lncode): - "updates the Translator.cpp file with the given translation entry" cppfile = os.path.join(os.path.dirname(__file__), "..", "Gui", "Language", "Translator.cpp") @@ -440,7 +438,6 @@ def updateTranslatorCpp(lncode): def doFile(tsfilepath, targetpath, lncode, qrcpath): - "updates a single ts file, and creates a corresponding qm file" basename = os.path.basename(tsfilepath)[:-3] @@ -475,7 +472,6 @@ def doFile(tsfilepath, targetpath, lncode, qrcpath): def doLanguage(lncode): - "treats a single language" if lncode == "en":