-
Notifications
You must be signed in to change notification settings - Fork 1
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
Update documentation #224
base: master
Are you sure you want to change the base?
Update documentation #224
Conversation
Codecov Report
@@ Coverage Diff @@
## master #224 +/- ##
=======================================
Coverage 91.81% 91.81%
=======================================
Files 36 36
Lines 3664 3664
Branches 418 418
=======================================
Hits 3364 3364
Misses 249 249
Partials 51 51 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comments so far...
# create a PipelineFile to represent the product file, set it's 'publish type' | ||
# attribute and add it to the handler's file collection | ||
# add the path to the handler's file collection, with keyword arguments being used to construct the | ||
# PipelineFile |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe add a link to PipelineFile.__init__
?
product = PipelineFile(product_path) | ||
product.publish_type = PipelineFilePublishType.UPLOAD_ONLY | ||
self.collection.add(product) | ||
self.add_to_collection(product) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a note that in this case (where the first arg is a PipelineFile
), additional kwargs passed to add_to_collection
have no effect (as per note in the docstring)
class MyHandler(HandlerBase): | ||
def dest_path(self, file_path): | ||
basename = os.path.basename(file_path) | ||
dest_filename = "IMOS_filename_01_XX_{basename}".format(basename=basename) | ||
return os.path.join('IMOS/MYFACILITY', dest_filename) | ||
|
||
* Writing :meth:`dest_path` and :meth:`archive_path` functions with an unmodified filename: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Writing :meth:`dest_path` and :meth:`archive_path` functions with an unmodified filename: | |
* Writing :meth:`dest_path` and :meth:`archive_path` functions with a modified filename: |
No description provided.