Extend data info #75
Open
Extend data info #75
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
kzqureshi
force-pushed
the
extend_data_info
branch
from
5b91394 to
86443d8
Compare
lang-m
requested changes
Feb 2, 2025
|
|
||
| Examples | ||
| -------- | ||
| 1. Creating data object. | ||
| 1. Creating data object using `dirname` |
There was a problem hiding this comment.
Suggested change
| 1. Creating data object using `dirname` | |
| 1. Creating data object using `path` |
Comment on lines
+43
to
+44
| >>> data = mdata.Data( | ||
| path="/home/zulfigak/ubermag_devtools/repos/micromagneticdata/micromagneticdata/tests/test_sample/rectangle" |
There was a problem hiding this comment.
Suggested change
| >>> data = mdata.Data( | |
| path="/home/zulfigak/ubermag_devtools/repos/micromagneticdata/micromagneticdata/tests/test_sample/rectangle" | |
| >>> path = Path(__file__).parent / 'tests' / 'test_sample' | |
| >>> data = mdata.Data(path=path) |
| 1. Creating data object. | ||
| 1. Creating data object using `dirname` | ||
|
|
||
| >>> import micromagneticdata as mdata |
There was a problem hiding this comment.
Suggested change
| >>> import micromagneticdata as mdata | |
| >>> import micromagneticdata as mdata | |
| >>> from pathlib import Path |
| ... | ||
| >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample') | ||
| >>> data = md.Data(name='rectangle', dirname=dirname) | ||
| >>> data = mdata.Data(name='rectangle', dirname=dirname) | ||
| ... |
Comment on lines
+99
to
+109
| 1. Representation string using `path` | ||
|
|
||
| >>> import micromagneticdata as mdata | ||
| ... | ||
| >>> data = mdata.Data( | ||
| path="/home/zulfigak/ubermag_devtools/repos/micromagneticdata/micromagneticdata/tests/test_sample/rectangle" | ||
| ) | ||
| >>> data | ||
| Data(...) | ||
|
|
||
| 2. Representation string using `name` and `dirname` |
There was a problem hiding this comment.
Two comments for all examples:
- Do not (!) use an absolute path corresponding to the directory structure on your laptop. Instead use
Path(__file__)as proposed as a change in one of my previous comments. - Showing the two different initialisation methods in all example is in my opinion not required. I would lean towards only showing
path. Opinion @samjrholt ?
| @@ -169,7 +244,7 @@ def __getitem__(self, item): | |||
| return md.Drive( | |||
| name=self.name, | |||
| number=range(self.n)[item], | |||
| dirname=self.dirname, | |||
| dirname=str(self.dirname), | |||
There was a problem hiding this comment.
I would prefer to allow pathlib.Path for dirname in Drive.
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.
extend data info to take path as input argument and deprecated the
dirname