kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Fix typos and misc. formatting [skip ci]

Browse Source 
Found via `codespell -q 3 -L aci,ake,aline,alle,alledges,alocation,als,ang,anid,ba,beginn,behaviour,bloaded,byteorder,calculater,cancelled,cancelling,cas,cascade,centimetre,childs,colour,colours,commen,currenty,dof,doubleclick,dum,eiter,elemente,feld,freez,hist,iff,indicies,initialisation,initialise,initialised,initialises,initialisiert,ist,kilometre,lod,mantatory,methode,metres,millimetre,modell,nd,noe,normale,normaly,nto,numer,oder,orgin,orginx,orginy,ot,pard,pres,programm,que,recurrance,rougly,seperator,serie,sinc,strack,substraction,te,thist,thru,tread,uint,unter,vertexes,wallthickness,whitespaces -S ./.git,*.po,*.ts,./ChangeLog.txt,./src/3rdParty,./src/Mod/Assembly/App/opendcm,./src/CXX,./src/zipios++,./src/Base/swig*,./src/Mod/Robot/App/kdl_cp,./src/Mod/Import/App/SCL,./src/WindowsInstaller,./src/Doc/FreeCAD.uml`
This commit is contained in:
luz.paz
2019-10-20 15:47:38 -04:00
committed by Yorik van Havre
parent 5783027945
commit 30a717beac
33 changed files with 75 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/Mod/Arch/importOBJ.py
View File

@@ -61,7 +61,7 @@ def findVert(aVertex,aList):
return None
def getIndices(obj,shape,offsetv,offsetvn):
"returns a list with 2 lists: vertices and face indexes, offsetted with the given amount"
"returns a list with 2 lists: vertices and face indexes, offset with the given amount"
vlist = []
vnlist = []
elist = []

7
src/Mod/Cam/App/cutting_tools.cpp
View File

@@ -354,7 +354,7 @@ bool cutting_tools::arrangecuts_ZLEVEL()
for (MOrderIt = m_MachiningOrder.begin();MOrderIt != m_MachiningOrder.end(); ++MOrderIt)
{
float temp_max = MOrderIt->first.z;
//the check if MOrderIt+1 != end is performend at the bottom of the function
//the check if MOrderIt+1 != end is performed at the bottom of the function
float temp_min = (MOrderIt+1)->first.z;
//set the direction flags
if (temp_max> temp_min)
@@ -828,7 +828,7 @@ TopoDS_Wire cutting_tools::ordercutShape(const TopoDS_Shape &aShape)
//
// // outfile << projectedPoint.X() <<","<<projectedPoint.Y()<<","<<projectedPoint.Z()<<std::endl;
// //Jetzt die aktuelle Kurve als BSpline interpolieren
// //check for intersections due to wrong offsetted points
// //check for intersections due to wrong offset points
// checkPointIntersection(finalPoints);
// std::vector<gp_Pnt> finalPointscorrected;
// finalPointscorrected.clear();
@@ -2738,7 +2738,7 @@ std::vector<SpiralHelper> cutting_tools::OffsetSpiral(const std::vector<SpiralHe
}
else if ((i+1==SpiralPoints.size()) && (OffsetPoints.rbegin()->SurfacePoint.SquareDistance(OffsetPoint.SurfacePoint)<(Precision::Confusion()*Precision::Confusion())))
{
//This part is necessary as the last point of the current spiral would otherwise not be offsetted
//This part is necessary as the last point of the current spiral would otherwise not be offset
OffsetPoints.pop_back();//Delete the two currently last points
OffsetPoints.pop_back();
OffsetPoints.push_back(OffsetPoint);//Add the last point
@@ -3643,4 +3643,3 @@ double cutting_tools::GetEdgeLength(const TopoDS_Edge& anEdge)
double length = lProps.Mass();
return length;
}

8
src/Mod/Cloud/App/AppCloud.cpp
View File

@@ -399,7 +399,7 @@ Cloud::CloudWriter::CloudWriter(const char* Url, const char* AccessKey, const ch
curl_easy_strerror(res));
curl_easy_cleanup(curl);
free( RequestData);
// Let's dump temporarly for debug purpose of s3v4 implementation
// Lets dump temporarily for debug purposes of s3v4 implementation
std::stringstream input(s);
@@ -422,7 +422,7 @@ Cloud::CloudWriter::CloudWriter(const char* Url, const char* AccessKey, const ch
parser->parse(myxml_buf);
auto* dom=parser->getDocument();
// Is there an Error entry into the document ?
// if yes then we must create the Bucket
// if yes, then we must create the Bucket
checkXML(dom);
if ( strcmp(errorCode,"NoSuchBucket") == 0 )
{
@@ -760,7 +760,7 @@ void Cloud::CloudWriter::writeFiles(void)
{
// use a while loop because it is possible that while
// processing the files new ones can be added
// processing the files, new ones can be added
std::string tmp="";
char *cstr;
size_t index = 0;
@@ -874,7 +874,7 @@ bool Cloud::Module::cloudRestore (const char *BucketName)
Document* doc = GetApplication().getActiveDocument();
// clean up if the document is not empty
// !TODO mind exceptions while restoring!
// !TODO: mind exceptions while restoring!
doc->clearUndos();

4
src/Mod/Draft/Draft.py
View File

@@ -1943,8 +1943,8 @@ def offset(obj,delta,copy=False,bind=False,sym=False,occ=False):
"""offset(object,delta,[copymode],[bind]): offsets the given wire by
applying the given delta Vector to its first vertex. If copymode is
True, another object is created, otherwise the same object gets
offsetted. If bind is True, and provided the wire is open, the original
and the offsetted wires will be bound by their endpoints, forming a face
offset. If bind is True, and provided the wire is open, the original
and the offset wires will be bound by their endpoints, forming a face
if sym is True, bind must be true too, and the offset is made on both
sides, the total width being the given delta length. If offsetting a
BSpline, the delta must not be a Vector but a list of Vectors, one for

2
src/Mod/Draft/DraftGeomUtils.py
View File

@@ -1192,7 +1192,7 @@ def offsetWire(wire,dvec,bind=False,occ=False,widthList=None):
offsetWire(wire,vector,[bind]): offsets the given wire along the
given vector. The vector will be applied at the first vertex of
the wire. If bind is True (and the shape is open), the original
wire and the offsetted one are bound by 2 edges, forming a face.
wire and the offset one are bound by 2 edges, forming a face.
If widthList is provided (values only, not lengths - i.e. no unit),
each value will be used to offset each corresponding edge in the wire

2
src/Mod/Draft/Resources/ui/TaskSelectPlane.ui
View File

@@ -124,7 +124,7 @@
<item>
<widget class="QLabel" name="label_7">
<property name="text">
<string>Or select a single vertex to move the current working plane without changing its orienatation. Then, press the button below</string>
<string>Or select a single vertex to move the current working plane without changing its orientation. Then, press the button below</string>
</property>
<property name="wordWrap">
<bool>true</bool>

2
src/Mod/Fem/App/FemAnalysis.h
View File

@@ -45,7 +45,7 @@ namespace Fem {
* compatibility handling via handleChangedPropertyName.
*
* This implies that it is not checked which objects are put into the
* Analsis object. Every document object of FreeCAD can be part of a
* Analysis object. Every document object of FreeCAD can be part of a
* Analysis.
*/
class AppFemExport FemAnalysis : public App::DocumentObjectGroup {

2
src/Mod/Fem/App/FemConstraintFluidBoundary.cpp
View File

@@ -70,7 +70,7 @@ ConstraintFluidBoundary::ConstraintFluidBoundary()
"Basic boundary type like inlet, wall, outlet,etc");
BoundaryType.setEnums(BoundaryTypes);
ADD_PROPERTY_TYPE(Subtype,(1),"FluidBoundary",(App::PropertyType)(App::Prop_None),
"Subtype defines more specific boudnary types");
"Subtype defines more specific boundary types");
Subtype.setEnums(WallSubtypes);
ADD_PROPERTY_TYPE(BoundaryValue,(0.0),"FluidBoundary",(App::PropertyType)(App::Prop_None),
"Scaler value for the specific value subtype, like pressure, velocity magnitude");

2
src/Mod/Fem/App/FemResultObject.cpp
View File

@@ -41,7 +41,7 @@ FemResultObject::FemResultObject()
ADD_PROPERTY_TYPE(Mesh,(0), "General",Prop_None,"Link to the corresponding mesh");
ADD_PROPERTY_TYPE(NodeNumbers,(0), "NodeData",Prop_None,"Numbers of the result nodes");
ADD_PROPERTY_TYPE(Stats,(0), "Data",Prop_None,"Statistics of the results");
ADD_PROPERTY_TYPE(Time,(0), "Data",Prop_None,"Time of analysis incement");
ADD_PROPERTY_TYPE(Time,(0), "Data",Prop_None,"Time of analysis increment");
// make read-only for property editor
NodeNumbers.setStatus(App::Property::ReadOnly, true);

52
src/Mod/Fem/coding_conventions.md
View File

@@ -1,17 +1,24 @@
# FEM coding_conventions
- These coding rules apply to FEM module code only. Other modules or the base system may use different coding rules especially in naming policy of Python.
These coding rules apply to FEM module code only. Other modules or the base system may use different coding rules especially in naming policy of Python.
## Spelling
- Be mindful of spelling. Spell checks are quite often neglected.
- [codespell]((https://github.com/codespell-project/codespell#updating) could be used
- Utilize [codespell](https://github.com/codespell-project/codespell) to discover and quickly correct spelling errors.
~~~
codespell -q 2 -S *.ts -L childs,dof,dum,methode,nd,normaly,uint,vertexes,freez src/Mod/Fem/
~~~
```bash
# Find typos
codespell -q 2 -S *.ts -L childs,dof,dum,methode,nd,normaly,uint,vertexes,freez src/Mod/Fem/
# Interactively fix said typos
codespell -i 3 -w -S *.ts -L childs,dof,dum,methode,nd,normaly,uint,vertexes,freez src/Mod/Fem/
```
**Notes:**
1) We recommend running the dev version as it uses the most up to date typo dictionaries.
2) To find the most amount of typos we recommend running a quick `pip install --upgrade`
See the [codespell docs](https://github.com/codespell-project/codespell#updating) for more info.
## Python and C++
#### Code formatting
### Code formatting
- All files should have a license header
- Unix line endings are preferred
- never use mixed line endings on one file
@@ -20,7 +27,7 @@ codespell -q 2 -S *.ts -L childs,dof,dum,methode,nd,normaly,uint,vertexes,freez
## Python
#### Code formatting
### Code formatting
- except W503 all Python code is pep8 compliant
- maximal line length is 100
- double quotes as string identifier
@@ -31,32 +38,29 @@ codespell -q 2 -S *.ts -L childs,dof,dum,methode,nd,normaly,uint,vertexes,freez
- snake_case_names
- ClassNames, variable_names_without_capitals and CONSTANTS_USE_CAPITALS, functions_without_capitals
- Function expected to return a value should indicate what is expected, so is_mesh_valid is a good name, but check_mesh is not a good name
- Class names, methode names and variable that are locally and not supposed to be used for scripting should start with underscore like _MyInternalClass
- Class names, method names and variable that are locally and not supposed to be used for scripting should start with underscore like _MyInternalClass
### Python code formatting tools
- flake8
- in source code directory on Linux shell
~~~
- **flake8** in source code directory on Linux shell
```bash
find src/Mod/Fem/ -name "*\.py" | grep -v InitGui.py | xargs -I [] flake8 --ignore=E266,W503 --max-line-length=100 []
~~~
```
- [LGTM](www.lgtm.com)
- TODO: check pylint
- automatic code formatter will not be used for existent code
- for new code if someone would like to use a code formatter black should be used
- Automatic code formatter will not be used for existent code
- For new code if someone would like to use a code formatter black should be used
### Coding
- print() vs. FreeCAD.Console.PrintMessage()
- FreeCAD.Console.PrintMessage() or Log or Error should be used
- print() should be used for debugging only
- forum topic https://forum.freecadweb.org/viewtopic.php?f=10&t=39110
- BTW: Console prints need a new line where as print does not need one
- `FreeCAD.Console.PrintMessage()` or Log or Error should be used
- `print()` should be used for debugging only
- [forum topic](https://forum.freecadweb.org/viewtopic.php?f=10&t=39110)
- BTW: Console prints need a new line where as print does not need one
### Documenting
- Python style is preferred over Doxygen style
- see ccx tools module in fem tools package
- see forum topic: https://forum.freecadweb.org/viewtopic.php?f=10&t=37094
Python style is preferred over Doxygen style
- see `ccx` tools module in fem tools package
- see [forum topic](https://forum.freecadweb.org/viewtopic.php?f=10&t=37094)
## C++
### Naming policy

2
src/Mod/Fem/femsolver/elmer/writer.py
View File

@@ -482,7 +482,7 @@ class Writer(object):
dimension = "M/L^3"
if name.startswith("Edge"):
# not tested, but it seems needed
# because denisty does not exist (IMHO, bernd)
# because density does not exist (IMHO, bernd)
density = None
if density:
density.Unit = Units.Unit(-2, 1)

2
src/Mod/Fem/femsolver/settings.py
View File

@@ -34,7 +34,7 @@ are supported:
- ElmerSolver
- Z88
To query settings about those solver the solver name must be given exactely in
To query settings about those solver the solver name must be given exactly in
the form written in the list above. To make the solver recognize settings for a
new solver have a look at :class:`_SolverDlg`.
"""

4
src/Mod/Fem/femtools/femutils.py
View File

@@ -195,7 +195,7 @@ def get_mesh_to_solve(analysis):
:returns:
A tuple ``(object, message)``. If and only if the analysis contains
exactely one mesh object the first value of the tuple is the mesh document
exactly one mesh object the first value of the tuple is the mesh document
object. Otherwise the first value is ``None`` and the second value is a
error message indicating what went wrong.
"""
@@ -235,7 +235,7 @@ def is_of_type(obj, ty):
:returns:
``True`` if *obj* is of type *ty*, ``False`` otherwise. Type must match
exactely: Derived objects are not considered to be of type of one of their
exactly: Derived objects are not considered to be of type of one of their
super classes.
"""
return type_of_obj(obj) == ty

2
src/Mod/Mesh/App/Core/Algorithm.cpp
View File

@@ -599,7 +599,7 @@ void MeshAlgorithm::SplitBoundaryLoops( std::list<std::vector<unsigned long> >&
it != aBorders.end(); ++it) {
bool split=false;
for (std::vector<unsigned long>::iterator jt = it->begin(); jt != it->end(); ++jt) {
// two (ore more) boundaries meet in one non-manifold point
// two (or more) boundaries meet in one non-manifold point
if (openPointDegree[*jt] > 2) {
split = true;
break;

4
src/Mod/Mesh/App/Core/SetOperations.h
View File

@@ -163,7 +163,7 @@ private:
std::set<MeshPoint> _cutPoints;
/** all edges */
std::map<Edge, EdgeInfo> _edges;
/** map from facet index to his cutted points (mesh 1 and mesh 2) Key: Facet-Index Value: List of iterators of set<MeshPoint> */
/** map from facet index to its cut points (mesh 1 and mesh 2) Key: Facet-Index Value: List of iterators of set<MeshPoint> */
std::map<unsigned long, std::list<std::set<MeshPoint>::iterator> > _facet2points[2];
/** Facets collected from region growing */
std::vector<MeshGeomFacet> _facetsOf[2];
@@ -172,7 +172,7 @@ private:
/** Cut mesh 1 with mesh 2 */
void Cut (std::set<unsigned long>& facetsNotCuttingEdge0, std::set<unsigned long>& facetsCuttingEdge1);
/** Trianglute each facets cutted with his cutting points */
/** Trianglute each facets cut with its cutting points */
void TriangulateMesh (const MeshKernel &cutMesh, int side);
/** search facets for adding (with region growing) */
void CollectFacets (int side, float mult);

2
src/Mod/Mesh/Gui/ViewProviderTransformDemolding.cpp
View File

@@ -200,7 +200,7 @@ void ViewProviderMeshTransformDemolding::valueChangedCallback(void)
temp.setTransform( SbVec3f(0,0,0), // no transformation
rot, // rotation from the dragger
SbVec3f(1,1,1), // no scaling
SbRotation() , // no scaling oriantation
SbRotation() , // no scaling orientation
SbVec3f(center.x,center.y,center.z)); // center of rotation
pcTransformDrag->setMatrix( temp );
}

2
src/Mod/Part/App/PartFeature.cpp
View File

@@ -163,7 +163,7 @@ App::DocumentObject *Feature::getSubObject(const char *subname,
bool copy = sCopy?true:false;
if(!copy) {
// Work around OCC bug on transforming circular edge with an
// offsetted surface. The bug probably affect other shape type,
// offset surface. The bug probably affect other shape type,
// too.
TopExp_Explorer exp(ts.getShape(),TopAbs_EDGE);
if(exp.More()) {

3
src/Mod/Part/Gui/ViewProviderExt.h
View File

@@ -129,7 +129,7 @@ public:
void unsetHighlightedPoints();
//@}
/** @name Color mangement methods
/** @name Color management methods
*/
//@{
virtual std::map<std::string,App::Color> getElementColors(const char *element=0) const override;
@@ -192,4 +192,3 @@ private:
}
#endif // PARTGUI_VIEWPROVIDERPARTEXT_H

2
src/Mod/Path/App/Area.cpp
View File

@@ -1768,7 +1768,7 @@ TopoDS_Shape Area::getShape(int index) {
FC_TIME_INIT(t);
// do offset first, then pocket the inner most offsetted shape
// do offset first, then pocket the inner most offset shape
std::list<shared_ptr<CArea> > areas;
makeOffset(areas,PARAM_FIELDS(AREA_MY,AREA_PARAMS_OFFSET));

2
src/Mod/Path/App/Area.h
View File

@@ -145,7 +145,7 @@ protected:
/** Called internally to obtain the combined children shapes */
TopoDS_Shape toShape(CArea &area, short fill, int reorient=0);
/** Obtain a list of offsetted areas
/** Obtain a list of offset areas
*
* See #AREA_PARAMS_OFFSET for description of the arguments.
*/

3
src/Mod/Robot/Gui/ViewProviderRobotObject.cpp
View File

@@ -350,7 +350,7 @@ void ViewProviderRobotObject::setAxisTo(float A1,float A2,float A3,float A4,floa
Robot::RobotObject* robObj = static_cast<Robot::RobotObject*>(pcObject);
if(Axis1Node)
// FIXME Uggly hack for the wrong transformation of the Kuka 500 robot VRML the minus sign on Axis 1
// FIXME Ugly hack for the wrong transformation of the Kuka 500 robot VRML the minus sign on Axis 1
Axis1Node->rotation.setValue(SbVec3f(0.0,1.0,0.0),A1*(M_PI/180));
if(Axis2Node)
Axis2Node->rotation.setValue(SbVec3f(0.0,1.0,0.0),A2*(M_PI/180));
@@ -391,4 +391,3 @@ void ViewProviderRobotObject::DraggerMotionCallback(SoDragger *dragger)
Base::Vector3d pos(translation[0],translation[1],translation[2]);
robObj->Tcp.setValue(Base::Placement(pos,rot));
}

2
src/Mod/Sketcher/Gui/CommandCreateGeo.cpp
View File

@@ -928,7 +928,7 @@ public:
arcRadius = (onSketchPos - EditCurve[0]).Length()/(2.0*sin(theta));
// At this point we need a unit normal vector pointing torwards
// At this point we need a unit normal vector pointing towards
// the center of the arc we are drawing. Derivation of the formula
// used here can be found at http://people.richland.edu/james/lecture/m116/matrices/area.html
double x1 = EditCurve[0].x;