Skip to content

Commit

Permalink
Rename docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ppizarror committed Aug 19, 2024
1 parent 66cb8ce commit 89e57c9
Show file tree
Hide file tree
Showing 20 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion MLStructFP/_types.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - TYPES
MLSTRUCT-FP - TYPES
Define globals types used by the code.
"""
Expand Down
2 changes: 1 addition & 1 deletion MLStructFP/db/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - DB
MLSTRUCT-FP - DB
Dataset load and objects.
"""
Expand Down
2 changes: 1 addition & 1 deletion MLStructFP/db/_c.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - DB - C
MLSTRUCT-FP - DB - C
Base FP components.
"""
Expand Down
2 changes: 1 addition & 1 deletion MLStructFP/db/_c_item.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - DB - CITEM
MLSTRUCT-FP - DB - CITEM
Item component.
"""
Expand Down
2 changes: 1 addition & 1 deletion MLStructFP/db/_c_point.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - DB - CPOINT
MLSTRUCT-FP - DB - CPOINT
Point component.
"""
Expand Down
2 changes: 1 addition & 1 deletion MLStructFP/db/_c_rect.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - DB - CRECT
MLSTRUCT-FP - DB - CRECT
Rectangle component.
"""
Expand Down
2 changes: 1 addition & 1 deletion MLStructFP/db/_c_room.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - DB - CROOM
MLSTRUCT-FP - DB - CROOM
Room component.
"""
Expand Down
2 changes: 1 addition & 1 deletion MLStructFP/db/_c_slab.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - DB - CSLAB
MLSTRUCT-FP - DB - CSLAB
Slab component.
"""
Expand Down
2 changes: 1 addition & 1 deletion MLStructFP/db/image/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - DB - IMAGE
MLSTRUCT-FP - DB - IMAGE
Dataset image operations.
"""
Expand Down
2 changes: 1 addition & 1 deletion MLStructFP/db/image/_base.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - DB - IMAGE - BASE
MLSTRUCT-FP - DB - IMAGE - BASE
Image of the surroundings of a rect.
"""
Expand Down
2 changes: 1 addition & 1 deletion MLStructFP/db/image/_rect_binary.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - DB - IMAGE - RECT BINARY
MLSTRUCT-FP - DB - IMAGE - RECT BINARY
Image of the surroundings of a rect.
"""
Expand Down
2 changes: 1 addition & 1 deletion MLStructFP/db/image/_rect_photo.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - DB - IMAGE - RECT PHOTO
MLSTRUCT-FP - DB - IMAGE - RECT PHOTO
Image of the true rect photo from the base image plan.
"""
Expand Down
2 changes: 1 addition & 1 deletion MLStructFP/utils/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - UTILS
MLSTRUCT-FP - UTILS
Utils (math, plots).
"""
Expand Down
2 changes: 1 addition & 1 deletion MLStructFP/utils/_geometry.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - DB - LINE 2D
MLSTRUCT-FP - DB - LINE 2D
Line definition class.
"""
Expand Down
2 changes: 1 addition & 1 deletion MLStructFP/utils/_mathlib.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - UTILS - MATH
MLSTRUCT-FP - UTILS - MATH
Math utils.
"""
Expand Down
2 changes: 1 addition & 1 deletion MLStructFP/utils/_path.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - UTILS - PATH
MLSTRUCT-FP - UTILS - PATH
Path utils.
"""
Expand Down
2 changes: 1 addition & 1 deletion MLStructFP/utils/_plot.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - UTILS - PLOT
MLSTRUCT-FP - UTILS - PLOT
Plotting utils.
"""
Expand Down
2 changes: 1 addition & 1 deletion build.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - BUILD
MLSTRUCT-FP - BUILD
Build file.
"""
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - SETUP
MLSTRUCT-FP - SETUP
Setup distribution.
"""
Expand Down
2 changes: 1 addition & 1 deletion test/test_db.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
MLSTRUCTFP - TEST - DB
MLSTRUCT-FP - TEST - DB
Test the dataset loader and object components.
"""
Expand Down

0 comments on commit 89e57c9

Please sign in to comment.