Skip to content
This repository has been archived by the owner on Oct 23, 2022. It is now read-only.

Fix typos in comments and docstrings #401

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ekmecic
Copy link

@ekmecic ekmecic commented May 24, 2022

Just a small PR to fix some typos I noticed while browsing the source and documentation. I am not seeking credit for this, it is a very minor fix.

@ghost
Copy link

ghost commented May 24, 2022

CLA assistant check
All CLA requirements met.

@codecov-commenter
Copy link

Codecov Report

Merging #401 (530270d) into main (84fe356) will not change coverage.
The diff coverage is 25.00%.

@@           Coverage Diff           @@
##             main     #401   +/-   ##
=======================================
  Coverage   51.01%   51.01%           
=======================================
  Files          80       80           
  Lines        7741     7741           
=======================================
  Hits         3949     3949           
  Misses       3792     3792           
Impacted Files Coverage Δ
src/Data/HumanEye.jl 0.00% <ø> (ø)
src/Examples/repeating_structure_examples.jl 0.00% <ø> (ø)
src/Geometry/AnalyticIntersection.jl 0.00% <0.00%> (ø)
src/Geometry/CSG/CSG.jl 32.10% <ø> (ø)
src/Geometry/CSG/Interval.jl 81.54% <ø> (ø)
src/Geometry/Primitives/AsphericSurface.jl 59.39% <ø> (ø)
src/Geometry/Primitives/Curves/BSpline.jl 66.66% <ø> (ø)
src/Geometry/Primitives/Curves/Bezier.jl 55.88% <ø> (ø)
src/Geometry/Primitives/NonCSG/ConvexPolygon.jl 61.53% <ø> (ø)
src/Geometry/Primitives/Plane.jl 75.00% <ø> (ø)
... and 17 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 84fe356...530270d. Read the comment docs.

@BrianGun
Copy link
Contributor

BrianGun commented Jun 9, 2022

@ekmecic Thank you for taking the time to make this PR. Documentation is an important part of every open source project, but especially so for this project which is being used by people who are probably optical engineers first and programmers second. There is still some bug with the CI, which has nothing to do with your PR. As soon as I figure that out I'll commit the PR.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants