Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document required attrs package #201

Closed
wilhadams opened this issue Aug 26, 2020 · 1 comment · Fixed by #214
Closed

Document required attrs package #201

wilhadams opened this issue Aug 26, 2020 · 1 comment · Fixed by #214

Comments

@wilhadams
Copy link
Collaborator

The attrs package is requred for IOData, but there's no mention of it anywhere in the README nor the developer documentation. This is also important because there's also an attr package, with similar functionality, and the import statement for the attrs package is import attr, which is confusing. I think putting a brief overview of how attrs works within IOData into the developer docs would make it easier for new developers to contribute.
@wilhadams wilhadams mentioned this issue Aug 26, 2020
Merged
@tovrstra
Copy link
Member

@wilhadams Thanks for the suggestion. I'll take care of this in #157. This PR converts one namedtuple to an attr class. We should do also the remaining ones, and add a few words of explanation to how it is used. We mainly use it for attribute validation and avoiding lengthy classes.

@tovrstra tovrstra mentioned this issue Aug 27, 2020
Closed
tovrstra added a commit to tovrstra/iodata that referenced this issue Sep 3, 2020
@tovrstra
Turn all numedtuples into attrs classes
b6b9caf 
Fixes theochem#201

Related to theochem#138

This PR includes:
- Attribute validation (to large extent, not every detail)
- attrutil module to facilitate validation of array attributes
- Documentation of how attrs is used in IOData
- Bug fix in CP2K loader
- Minor fixes elsewhere
tovrstra added a commit to tovrstra/iodata that referenced this issue Sep 3, 2020
@tovrstra
Turn all numedtuples into attrs classes
5f35f10 
Fixes theochem#201

Related to theochem#138

This PR includes:
- Attribute validation (to large extent, not every detail)
- attrutil module to facilitate validation of array attributes
- Documentation of how attrs is used in IOData
- Bug fix in CP2K loader
- Minor fixes elsewhere
tovrstra added a commit to tovrstra/iodata that referenced this issue Sep 3, 2020
@tovrstra
Turn all numedtuples into attrs classes
e0d7f6a 
Fixes theochem#201

Related to theochem#138 and theochem#157 (which were earlier attempts)

This PR includes:
- Attribute validation (to large extent, not every detail)
- attrutil module to facilitate validation of array attributes
- Documentation of how attrs is used in IOData
- Bug fix in CP2K loader
- Minor fixes elsewhere
tovrstra added a commit to tovrstra/iodata that referenced this issue Sep 3, 2020
@tovrstra
Turn all numedtuples into attrs classes
54bb66a 
Fixes theochem#201

Related to theochem#138 and theochem#157 (which were earlier attempts)

This PR includes:
- Attribute validation (to large extent, not every detail)
- attrutil module to facilitate validation of array attributes
- Documentation of how attrs is used in IOData
- Bug fix in CP2K loader
- Minor fixes elsewhere
tovrstra added a commit to tovrstra/iodata that referenced this issue Sep 3, 2020
@tovrstra
Turn all numedtuples into attrs classes
13b841d 
Fixes theochem#201

Related to theochem#138 and theochem#157 (which were earlier attempts)

This PR includes:
- Attribute validation (to large extent, not every detail)
- attrutil module to facilitate validation of array attributes
- Documentation of how attrs is used in IOData
- Bug fix in CP2K loader, related to theochem/gbasis#78
- Minor fixes elsewhere to satisfy attribute validators
@tovrstra tovrstra mentioned this issue Sep 3, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@tovrstra @wilhadams