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.

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

Provide documentation of attributes in Jobs class #130

Open
jhkennedy opened this issue Jun 29, 2021 · 0 comments
Open

Provide documentation of attributes in Jobs class #130

jhkennedy opened this issue Jun 29, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@jhkennedy
Copy link
Contributor

Job instances have a lot of attributes that are currently undocumented:

self.job_id = job_id
self.job_type = job_type
self.request_time = request_time
self.status_code = status_code
self.user_id = user_id
self.name = name
self.job_parameters = job_parameters
self.files = files
self.browse_images = browse_images
self.thumbnail_images = thumbnail_images
self.expiration_time = expiration_time

It'd be nice to provide them as a class level docstring -- see:

@jhkennedy jhkennedy added the documentation Improvements or additions to documentation label Jun 29, 2021
@jhkennedy jhkennedy mentioned this issue Jun 29, 2021
@jhkennedy jhkennedy added the good first issue Good for newcomers label Aug 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant