minor tweaks(docs, typos)

ryansurf · Jul 29, 2024 · 103fdbb · 103fdbb · github-actions · Jul 29, 2024
1 parent d4c5853
commit 103fdbb
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 1 deletion.
diff --git a/docs/cheat_sheet.md b/docs/cheat_sheet.md
@@ -39,6 +39,7 @@ When developing, these commands may come in handy:
 | `make send_email`  |  Runs `send_email.py` |
 | `make lint`  |  Runs the ruff linter |
 | `make format`  |  Runs the ruff formatter |
+| `make clean`  |  Cleans up files generated during testing (`.coverage`, `pytest_cache`, etc.) |
 
 
 ## [Git](https://education.github.com/git-cheat-sheet-education.pdf)

diff --git a/src/dev_streamlit.py b/src/dev_streamlit.py
@@ -71,6 +71,7 @@
     report_dict, gpt_response, lat, long = get_report
 
     # Displays the map
+    # TODO: Configure map to only show nearby surf spots based on the lat/long
     if map:
         map_data = sl_help.map_data(lat, long)
         st_folium(map_data, width=725)

diff --git a/src/streamlit_helper.py b/src/streamlit_helper.py
@@ -1,5 +1,5 @@
 """
-Helper functions for the streamlit frontent
+Helper functions for the streamlit frontend
 """
 
 import sys
File	Stmts	Miss	Cover	Missing
src
__init__.py	0	0	100%
api.py	101	6	94%	30, 48, 70–71, 103–104
art.py	9	3	67%	24–25, 37
cli.py	25	5	80%	26, 37, 55–56, 60
dev_streamlit.py	37	37	0%	1–86
gpt.py	10	6	40%	16–21, 32–45
helper.py	157	58	63%	53, 55, 57, 59, 61, 63, 65, 67, 69, 71, 73, 75, 77, 79, 91, 102–106, 132, 134, 136, 145–153, 165, 178–179, 197–199, 209, 211–212, 235–236, 274–284, 291–299
send_email.py	24	24	0%	5–48
server.py	41	41	0%	5–82
settings.py	22	0	100%
streamlit_helper.py	33	33	0%	5–90
TOTAL	459	213	54%