Mixed improvements #79
Merged
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
Member
kretep
commented
Jun 25, 2024
kretep
commented
- Fix typos, documentation
- Validation for date format
- Validate on write
- Update workflows
Copy from paradigma package
| @@ -48,11 +50,11 @@ class TSDFMetadata: | |||
|
|
|||
| file_dir_path: str | |||
| """ A reference to the directory path, so we don't need it again when reading associated binary files. """ | |||
| metadata_file_name: str | |||
| metadata_file_name: str #TODO: do we need this?? / is it used? | |||
There was a problem hiding this comment.
This is only used when we want to override the existing metadata file by updating the corresponding tsdf object, but that might be unnecessary.
There was a problem hiding this comment.
So when saving existing metadata at a new location, it is not needed to update this, right? Because that's how I see it being used often.
There was a problem hiding this comment.
As far as I know, when saving to a new location the location is expected to be explicitly specified when writing to the disc (this is more of an implicit location tag)
| :param metadata: dictionary containing the metadata. | ||
|
|
||
| :return: TSDFMetadata object. | ||
| :param file_dir: path to the directory where the file will be saved. |
There was a problem hiding this comment.
We could at one point convert all the documentation to NumPy style (we started it for the dbpd), just not to forget.
vedran-kasalica
approved these changes
Jul 11, 2024
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.