spelling nits in docs

This commit is contained in:
Ben Christenson 2020-02-23 06:57:39 -06:00 committed by Florian Festi
parent eeb1baf352
commit bc2d16fb16
12 changed files with 26 additions and 26 deletions

View File

@ -19,7 +19,7 @@ You will often be compelled to just do a quick thing that will solve
your immediate needs. That's fine. But nevertheless it is often worth your immediate needs. That's fine. But nevertheless it is often worth
doing things the right way and be able to submit your changes doing things the right way and be able to submit your changes
upstream. For one to give something back to the community. But also upstream. For one to give something back to the community. But also
for purly selfish reasons like getting the code maintained. Also for purely selfish reasons like getting the code maintained. Also
Boxes.py is designed to make doing things properly the easy way. Boxes.py is designed to make doing things properly the easy way.
Here are some guidelines that make this easier. Depending on what you Here are some guidelines that make this easier. Depending on what you
@ -34,12 +34,12 @@ or are going to finish it on your own.
* You can merge them into your master branch to have them all in one place * You can merge them into your master branch to have them all in one place
* Please continue your work in the branches and repeatedly merge them to master * Please continue your work in the branches and repeatedly merge them to master
* Before submitting a pull request intened to go upstream have clean patches that are self contained and error free * Before submitting a pull request intended to go upstream have clean patches that are self contained and error free
* Re-order and squash patches with *git rebase -i* * Re-order and squash patches with *git rebase -i*
* The patches should contaning meaningful changes and not (nessesarily) reflect how the code was created * The patches should containing meaningful changes and not (necessarily) reflect how the code was created
* Rebase your branch to the current master branch * Rebase your branch to the current master branch
* Be prepared that you code may get reworked before being merged upstream * Be prepared that your code may get reworked before being merged upstream
* Submit a pull request in GitHub based on your feature branch * Submit a pull request in GitHub based on your feature branch
@ -62,7 +62,7 @@ Boxes.py. Here are some guidelines that make it easier to get them added:
* Start with a copy of another generator or *boxes/generators/_template.py* * Start with a copy of another generator or *boxes/generators/_template.py*
* Commit changes to the library in separate patches * Commit changes to the library in separate patches
* Use parameters with sane defaults instead of hard coding dimmensions * Use parameters with sane defaults instead of hard coding dimensions
* Simple generators can end up as one single commit * Simple generators can end up as one single commit
* For more complicated generators there can be multiple patches - * For more complicated generators there can be multiple patches -
each adding another feature each adding another feature
@ -77,7 +77,7 @@ documentation feel free to submit a pull request or open a ticket
pointing out what should be changed or even suggesting a better text. pointing out what should be changed or even suggesting a better text.
To check your changes docs need to be build with *make html* in To check your changes docs need to be build with *make html* in
*documentation/src*. This places the compliled documentation in *documentation/src*. This places the compiled documentation in
*documentation/build/html*. You need to have *sphinx* installed for *documentation/build/html*. You need to have *sphinx* installed for
this to work. this to work.

View File

@ -16,7 +16,7 @@ generators. See https://florianfesti.github.io/boxes/html/generators.html for th
Features Features
-------- --------
Boxes.py generates SVG images that can be viewed directly in a web brower but also Boxes.py generates SVG images that can be viewed directly in a web browser but also
postscript and - with pstoedit as external helper - other vector formats postscript and - with pstoedit as external helper - other vector formats
including dxf, plt (aka hpgl) and gcode. including dxf, plt (aka hpgl) and gcode.

View File

@ -32,7 +32,7 @@ boxes \- program design boxes
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP
\fBboxes\fR \fBboxes\fR
is a program that generates SVG images that can be viewed directly in a web brower but also postscript and \- with pstoedit as external helper \- other vector formats including dxf, plt (aka hpgl) and gcode\&. is a program that generates SVG images that can be viewed directly in a web browser but also postscript and \- with pstoedit as external helper \- other vector formats including dxf, plt (aka hpgl) and gcode\&.
.PP .PP
Of course the library and the generators allow selecting the "thickness" of the material used and automatically adjusts lengths and width of joining fingers and other elements\&. Of course the library and the generators allow selecting the "thickness" of the material used and automatically adjusts lengths and width of joining fingers and other elements\&.
.PP .PP

View File

@ -64,7 +64,7 @@ Edges
Edges are turtle graphic commands. But they have been elevated to Edges are turtle graphic commands. But they have been elevated to
proper Classes to handle outsets. They can be passed as parameters to parts. proper Classes to handle outsets. They can be passed as parameters to parts.
There is a set of standard edges found in ``.edges``. They are There is a set of standard edges found in ``.edges``. They are
acciociated with a single char which can be used instead of the associated with a single char which can be used instead of the
Edge object itself at most places. This allows passing the edge Edge object itself at most places. This allows passing the edge
description of a part as a string. description of a part as a string.

View File

@ -8,7 +8,7 @@ catch the places the do need to care.
Burn correction is done by increasing the radius of all outer Burn correction is done by increasing the radius of all outer
corners. This moves all the straight lines outward by the same corners. This moves all the straight lines outward by the same
amount. This has he addeed benefit of not needing to change the length amount. This has the added benefit of not needing to change the length
of the straight lines -- making them independent of the adjacent of the straight lines -- making them independent of the adjacent
angles. An issue arises when it comes to inner corners. If they do angles. An issue arises when it comes to inner corners. If they do
have a radius reducing it by the burn value does the right thing. But have a radius reducing it by the burn value does the right thing. But
@ -41,9 +41,9 @@ In case developers move to a feature inside of a part or executing
callbacks while implementing a part they need to be aware of the burn callbacks while implementing a part they need to be aware of the burn
correction. :py:meth:`boxes.Boxes.cc` does correct for the out-set if correction. :py:meth:`boxes.Boxes.cc` does correct for the out-set if
called without an **y** parameter. But if a value is given one has to called without an **y** parameter. But if a value is given one has to
add **self.burn** to compansate. Note that the **x** value typically add **self.burn** to compensate. Note that the **x** value typically
does not have to be corrected as the callbacks are executed from right does not have to be corrected as the callbacks are executed from right
underneeth the part. underneath the part.
A similar approach is necessary when moving to a feature drawn inside A similar approach is necessary when moving to a feature drawn inside
the part without the use of callbacks. Here you typically have to the part without the use of callbacks. Here you typically have to

View File

@ -34,7 +34,7 @@ place. They are enabled with the **tabs** parameter. All
**Edges** automatically create about two tabs. So parts like **Edges** automatically create about two tabs. So parts like
:py:meth:`boxes.Boxes.rectangularWall` will have 8 tabs holding them :py:meth:`boxes.Boxes.rectangularWall` will have 8 tabs holding them
in place. Because of this developers often don't need to be concerned in place. Because of this developers often don't need to be concerned
about tabs. But some part may be complitely drawn by low level Turtle about tabs. But some part may be completely drawn by low level Turtle
Graphics commands. For those both :py:meth:`boxes.Boxes.edge` and Graphics commands. For those both :py:meth:`boxes.Boxes.edge` and
:py:meth:`boxes.Boxes.corner` do support a **tabs** parameter. In :py:meth:`boxes.Boxes.corner` do support a **tabs** parameter. In
addition the length of the line segments in :py:meth:`boxes.Boxes.polyline` can addition the length of the line segments in :py:meth:`boxes.Boxes.polyline` can
@ -45,7 +45,7 @@ Draw Commands
These commands do not change the coordinate system but get the These commands do not change the coordinate system but get the
coordinates passed as parameters. All of them are either som sort of coordinates passed as parameters. All of them are either som sort of
hole or text. These artefacts are placed somewhere independently of hole or text. These artifacts are placed somewhere independently of
some continuous outline of the part their on. some continuous outline of the part their on.
.. automethod:: boxes.Boxes.hole .. automethod:: boxes.Boxes.hole
@ -72,7 +72,7 @@ Hexagonal Hole patterns
....................... .......................
Hexagonal hole patterns are one way to have some ventilation for Hexagonal hole patterns are one way to have some ventilation for
housings maded with Boxes.py. Right now both ``.rectangularWall()`` housings made with Boxes.py. Right now both ``.rectangularWall()``
and ``.roundedPlate()`` do supports this pattern directly by passing and ``.roundedPlate()`` do supports this pattern directly by passing
the parameters to the calls. For other use cases these more low level the parameters to the calls. For other use cases these more low level
methods can be used. methods can be used.
@ -81,7 +81,7 @@ For now this is the only supported pattern for ventilation slots. More
may be added in the future. may be added in the future.
There is a global Boxes.hexHolesSettings object that is used if no settings are There is a global Boxes.hexHolesSettings object that is used if no settings are
passed. It currently is just a tuple of (r, dist, style) defualting to passed. It currently is just a tuple of (r, dist, style) defaulting to
(5, 3, 'circle') but might be replace by a Settings instance in the future. (5, 3, 'circle') but might be replace by a Settings instance in the future.
.. automethod:: boxes.Boxes.hexHolesRectangle .. automethod:: boxes.Boxes.hexHolesRectangle

View File

@ -66,7 +66,7 @@ special purpose one that does add the triangles:
.. autoclass:: boxes.generators.bintray.BinFrontEdge .. autoclass:: boxes.generators.bintray.BinFrontEdge
The ``hi`` (height of inner walls) argument was removed although the The ``hi`` (height of inner walls) argument was removed although the
variable is still used internally - out of lazyness. variable is still used internally - out of laziness.
To complete the bin the front walls are added. Follow up patches then To complete the bin the front walls are added. Follow up patches then
switched the slots between the vertical and horizontal walls to have switched the slots between the vertical and horizontal walls to have

View File

@ -2,7 +2,7 @@ Existing Parts
-------------- --------------
A couple of commands can create whole parts like walls. Typically the A couple of commands can create whole parts like walls. Typically the
sizes given are the inner dimmensions not including additional space sizes given are the inner dimension not including additional space
needed for burn compensation or joints. needed for burn compensation or joints.
Currently there are the following parts: Currently there are the following parts:

View File

@ -21,7 +21,7 @@ the x axis. You do not have to restore the coordinate settings in the
callback. callback.
Instead of functions it can be handy to use a lambda expression Instead of functions it can be handy to use a lambda expression
calling the one building block funtion you need (e.g. fingerHolesAt). calling the one building block function you need (e.g. fingerHolesAt).
For your own parts you can use this helper function: For your own parts you can use this helper function:
@ -52,7 +52,7 @@ implement a ``move`` parameter:
.. automethod:: boxes.Boxes.move .. automethod:: boxes.Boxes.move
It needs to be called before and after drawing the actual part with It needs to be called before and after drawing the actual part with
the proper ``before`` paramter set. the proper ``before`` parameter set.
The edges parameter The edges parameter
................... ...................

View File

@ -66,7 +66,7 @@ are required:
./setup.py install ./setup.py install
3. Now :code:`boxes` and :code:`boxesserver` can be runned like other commands 3. Now :code:`boxes` and :code:`boxesserver` can be executed like other commands
and the Inkscape extension should be available. and the Inkscape extension should be available.
@ -111,7 +111,7 @@ which needs to be changed to
#export PYTHONPATH="$TOP/lib/python$PYTHON_VERS/site-packages/" #export PYTHONPATH="$TOP/lib/python$PYTHON_VERS/site-packages/"
This forces Inkscape to use the Python version installed by Homebrew which This forces Inkscape to use the Python version installed by Homebrew which
has all the necessary dependecies installed. has all the necessary dependencies installed.
Note: This might break other extensions. In this case simply change the line Note: This might break other extensions. In this case simply change the line
back and restart Inkscape. back and restart Inkscape.

View File

@ -55,8 +55,8 @@ very important to get the value right - especially if there are
fingers that need to fit into some holes. Be aware that many materials fingers that need to fit into some holes. Be aware that many materials
may differ from their nominal value. You should **always measure the may differ from their nominal value. You should **always measure the
thickness** for every sheet unless you have a very reliable supply thickness** for every sheet unless you have a very reliable supply
that is known to stick very closly to specifications. For (ply) wood that is known to stick very closely to specifications. For (ply) wood
even a 100th of a milimeter makes a notable difference in how stiff even a 100th of a millimeter makes a notable difference in how stiff
the fit is. Harder more brittle materials may be even more picky. the fit is. Harder more brittle materials may be even more picky.
burn burn
@ -133,7 +133,7 @@ reference
Converting vector graphics is error prone. Many formats have very Converting vector graphics is error prone. Many formats have very
weird ideas how their internal units translates to real world weird ideas how their internal units translates to real world
dimmensions. If reference is set to non zero Boxes.py renders a rectangle of dimensions. If reference is set to non zero Boxes.py renders a rectangle of
the given length. It can be used to check if the drawing is still at the given length. It can be used to check if the drawing is still at
the right scale or may give clues on how to scale it back to the right the right scale or may give clues on how to scale it back to the right
proportions. proportions.

View File

@ -59,7 +59,7 @@ class CustomBuildExtCommand(build_py):
# then here is the default behavior: # then here is the default behavior:
try: try:
path = check_output(["inkscape", "-x"]).decode().strip() path = check_output(["inkscape", "-x"]).decode().strip()
if not os.access(path, os.W_OK): # Can we install globaly if not os.access(path, os.W_OK): # Can we install globally
# Not tested on Windows and Mac # Not tested on Windows and Mac
path = os.path.expanduser("~/.config/inkscape/extensions") path = os.path.expanduser("~/.config/inkscape/extensions")
self.distribution.data_files.append( self.distribution.data_files.append(