Skip to content

Commit

Permalink
improve doc string of Part.sortEdges
Browse files Browse the repository at this point in the history
  • Loading branch information
wwmayer committed Jun 20, 2019
1 parent dfccd68 commit 1031644
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions src/Mod/Part/App/AppPartPy.cpp
Expand Up @@ -407,11 +407,17 @@ class Module : public Py::ExtensionModule<Module>
"getSortedClusters(list of edges) -- Helper method to sort and cluster a variety of edges"
);
add_varargs_method("__sortEdges__",&Module::sortEdges,
"__sortEdges__(list of edges) -- Helper method to sort an unsorted list of edges so that afterwards\n"
"two adjacent edges share a common vertex"
"__sortEdges__(list of edges) -- list of edges\n"
"Helper method to sort an unsorted list of edges so that afterwards\n"
"the start and end vertex of two consecutive edges are geometrically coincident.\n"
"It returns a single list of edges and the algorithm stops after the first set of\n"
"connected edges which means that the output list can be smaller than the input list.\n"
"The sorted list can be used to create a Wire."
);
add_varargs_method("sortEdges",&Module::sortEdges2,
"sortEdges(list of edges) -- Helper method to sort a list of edges into a list of list of connected edges"
"sortEdges(list of edges) -- list of lists of edges\n"
"It does basically the same as __sortEdges__ but sorts all input edges and thus returns\n"
"a list of lists of edges"
);
add_varargs_method("__toPythonOCC__",&Module::toPythonOCC,
"__toPythonOCC__(shape) -- Helper method to convert an internal shape to pythonocc shape"
Expand Down

0 comments on commit 1031644

Please sign in to comment.