ryansurf / cli-surf

Get surf and ocean data from the command line interface
7 stars 10 forks source link

Documentation updates! #38

Closed ryansurf closed 1 month ago

ryansurf commented 1 month ago

@K-dash

This PR makes changes to the documentation.

The following changes have been made:

I sent you an invite to be a collaborator, so I think you should be able to merge this PR. Let me know if you have any issues!

github-actions[bot] commented 1 month ago

Coverage

Coverage Report
FileStmtsMissCoverMissing
src
   __init__.py00100% 
   api.py86693%30, 48, 70–71, 103–104
   art.py9367%24–25, 37
   cli.py23483%34, 50–51, 55
   gpt.py10640%16–21, 32–45
   helper.py1435264%50, 52, 54, 56, 58, 60, 62, 64, 66, 68, 70, 81, 92–96, 129–137, 149, 162–163, 181–183, 193, 195–196, 218–219, 256–266, 273–281
   send_email.py24240%5–48
   server.py41410%5–82
   settings.py220100% 
TOTAL35813662% 

Tests Skipped Failures Errors Time
9 0 :zzz: 0 :x: 0 :fire: 12.503s :stopwatch:
ryansurf commented 1 month ago

@ryansurf

I have reviewed the changes! Please take a look :)

Thank you! I'll implement the changes you recommended and submit another PR

K-dash commented 1 month ago

Thank you! I'll implement the changes you recommended and submit another PR

You're welcome!

(Please ignore this if you already know 😃) In the usual review process, you would create a fix commit in the same PR and push it to show that you have addressed the feedback. However, if the fix is expected to take time or can be handled later, the workflow is to create a separate PR. In this case, I judged that the latter seems applicable, so for now, I will go ahead and merge this PR :)

ryansurf commented 1 month ago

Thank you! I'll implement the changes you recommended and submit another PR

You're welcome!

(Please ignore this if you already know 😃) In the usual review process, you would create a fix commit in the same PR and push it to show that you have addressed the feedback. However, if the fix is expected to take time or can be handled later, the workflow is to create a separate PR. In this case, I judged that the latter seems applicable, so for now, I will go ahead and merge this PR :)

I see, thank you for the merge 😄