fix: in DataUpload, commented unused function & added docs #132
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
documented exitState, can_upload, initSuccess
6 tasks
|
lastConnectTime has no uses outside of this header file. Should I add a commit to remove lastConnectTime, or simply add documentation for it? |
ntlhui
requested changes
Nov 17, 2024
documented initSuccess, and canUpload commented out exitState (unused function)
Tylody
changed the title
ntlhui
requested changes
Nov 22, 2024
| @@ -157,7 +157,10 @@ void DataUpload::exit(void) | |||
| } | |||
| } | |||
|
|
|||
| // In smartfin-fw2/src/dataUpload::DataUpload::exitState(void), we return based on the water sensor state. If the system is in the water, we redeploy, otherwise we go to sleep. | |||
There was a problem hiding this comment.
Either format as docstring and comment out, or remove documentation comment
| int initSuccess; | ||
| system_tick_t lastConnectTime; | ||
| STATES_e exitState(void); | ||
| //In smartfin-fw2/src/dataUpload::DataUpload::exitState(void), we return based on the water sensor state. If the system is in the water, we redeploy, otherwise we go to sleep. |
There was a problem hiding this comment.
Either format as docstring and comment out, or remove documentation comment
Comment on lines
+58
to
+59
| * Returns that the data upload is possible if: the recorder has data, is connected to a cloud | ||
| * service, is not in water, and the battery has enough voltage for an upload. If the system is currently in water, we redeploy, otherwise we go to sleep. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
documented exitState, can_upload, initSuccess