diff --git a/src/Mod/CAM/PathSimulator/App/PathSim.pyi b/src/Mod/CAM/PathSimulator/App/PathSim.pyi index 68851af71f..79c7b27627 100644 --- a/src/Mod/CAM/PathSimulator/App/PathSim.pyi +++ b/src/Mod/CAM/PathSimulator/App/PathSim.pyi @@ -6,10 +6,9 @@ from typing import Any, Final from Base.BaseClass import BaseClass from Base.Metadata import export - +from Base.Placement import Placement from Part.App.TopoShape import TopoShape from Mesh.App.Mesh import Mesh -from Base.Placement import Placement from CAM.App.Command import Command @export( diff --git a/src/Mod/Import/App/StepShape.pyi b/src/Mod/Import/App/StepShape.pyi index 1fdee6f85b..2e584a28b3 100644 --- a/src/Mod/Import/App/StepShape.pyi +++ b/src/Mod/Import/App/StepShape.pyi @@ -24,6 +24,7 @@ class StepShape(PyObjectBase): """ def read(self) -> Any: - """method read() - Read a STEP file into memory and make it accessible""" + """ + Read a STEP file into memory and make it accessible + """ ... diff --git a/src/Mod/PartDesign/App/Body.pyi b/src/Mod/PartDesign/App/Body.pyi index fa044d35e4..d9bb8e4070 100644 --- a/src/Mod/PartDesign/App/Body.pyi +++ b/src/Mod/PartDesign/App/Body.pyi @@ -24,7 +24,6 @@ class Body(BodyBase): def insertObject(self, feature: object, target: object, after: bool = False, /) -> None: """ - insertObject(feature, target, after=False) Insert the feature into the body after the given feature. @param feature The feature to insert into the body diff --git a/src/Mod/PartDesign/Gui/ViewProvider.pyi b/src/Mod/PartDesign/Gui/ViewProvider.pyi index cfb237b472..d5292c3383 100644 --- a/src/Mod/PartDesign/Gui/ViewProvider.pyi +++ b/src/Mod/PartDesign/Gui/ViewProvider.pyi @@ -22,7 +22,7 @@ class ViewProvider(ViewProviderPartExt): def setBodyMode(self, mode: bool, /) -> None: """ - setBodyMode(bool): body mode means that the object is part of a body + body mode means that the object is part of a body and that the body is used to set the visual properties, not the features. Hence setting body mode to true will hide most viewprovider properties. """ @@ -30,7 +30,7 @@ class ViewProvider(ViewProviderPartExt): def makeTemporaryVisible(self, visible: bool, /) -> None: """ - makeTemporaryVisible(bool): makes this viewprovider visible in the + makes this viewprovider visible in the scene graph without changing any properties, not the visibility one and also not the display mode. This can be used to show the shape of this viewprovider from other viewproviders without doing anything to the document and properties. diff --git a/src/Mod/Sketcher/App/Sketch.pyi b/src/Mod/Sketcher/App/Sketch.pyi index 70a25fbfba..31ef21fd1a 100644 --- a/src/Mod/Sketcher/App/Sketch.pyi +++ b/src/Mod/Sketcher/App/Sketch.pyi @@ -64,7 +64,7 @@ class Sketch(Persistence): self, GeoIndex: int, PointPos: Vector, Vector: Vector, relative: bool = False, / ) -> None: """ - moveGeometry(GeoIndex,PointPos,Vector,[relative]) - move a given point (or curve) + Move a given point (or curve). to another location. It moves the specified point (or curve) to the given location by adding some temporary weak constraints and solve the sketch. diff --git a/src/Mod/Spreadsheet/App/Sheet.pyi b/src/Mod/Spreadsheet/App/Sheet.pyi index e3d1e0047e..82dd460022 100644 --- a/src/Mod/Spreadsheet/App/Sheet.pyi +++ b/src/Mod/Spreadsheet/App/Sheet.pyi @@ -142,44 +142,44 @@ class Sheet(DocumentObject): """Get given spreadsheet row height""" ... - def touchCells(self) -> Any: - """touchCells(from, to=None): touch cells in the given range""" + def touchCells(self, address: str, address_to: str | None = None, /) -> None: + """touch cells in the given range""" ... - def recomputeCells(self) -> Any: - """recomputeCells(from, to=None) - + def recomputeCells(self, address: str, address_to: str | None = None, /) -> Any: + """ Manually recompute cells in the given range with the given order without - following dependency order.""" + following dependency order. + """ ... - def getUsedCells(self) -> Any: - """getUsedCells() - + def getUsedCells(self) -> list[str]: + """ Get a list of the names of all cells that are marked as used. These cells may - or may not have a non-empty string content.""" + or may not have a non-empty string content. + """ ... - def getNonEmptyCells(self) -> Any: - """getNonEmptyCells() - - Get a list of the names of all cells with data in them.""" + def getNonEmptyCells(self) -> list[str]: + """ + Get a list of the names of all cells with data in them. + """ ... - def getUsedRange(self) -> Any: - """getUsedRange() - + def getUsedRange(self) -> tuple[str, str]: + """ Get a the total range of the used cells in a sheet, as a pair of strings representing the lowest row and column that are used, and the highest row and column that are used (inclusive). Note that the actual first and last cell - of the block are not necessarily used.""" + of the block are not necessarily used. + """ ... - def getNonEmptyRange(self) -> Any: - """getNonEmptyRange() - + def getNonEmptyRange(self) -> tuple[str, str]: + """ Get a the total range of the used cells in a sheet, as a pair of cell addresses representing the lowest row and column that contain data, and the highest row and column that contain data (inclusive). Note that the actual first and last cell - of the block do not necessarily contain anything.""" + of the block do not necessarily contain anything. + """ ... diff --git a/src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.pyi b/src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.pyi index d3e4e5e958..e8085bc056 100644 --- a/src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.pyi +++ b/src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.pyi @@ -27,22 +27,10 @@ class ViewProviderSpreadsheet(ViewProviderDocumentObject): """Get access to the sheet view""" ... - def showSheetMdi(self) -> Any: - """ - Create (if necessary) and switch to the Spreadsheet MDI. - - showSheetMdi() - - Returns: None - """ + def showSheetMdi(self) -> None: + """Create (if necessary) and switch to the Spreadsheet MDI.""" ... - def exportAsFile(self) -> Any: - """ - Export the sheet as a file. - - exportAsFile() - - Returns: None - """ + def exportAsFile(self) -> None: + """Export the sheet as a file.""" ...