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

Update documentation #224

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Update documentation #224

wants to merge 2 commits into from

Conversation

ghost
Copy link

@ghost ghost commented Jan 13, 2021

No description provided.

@ghost ghost force-pushed the docs-update branch from 8e015a3 to f17e938 Compare January 13, 2021 04:02
@codecov
Copy link

codecov bot commented Jan 13, 2021

Codecov Report

Merging #224 (1f77b2d) into master (34f3ea3) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 34f3ea3...1f77b2d. Read the comment docs.

@ghost ghost force-pushed the docs-update branch from f17e938 to 1f77b2d Compare January 19, 2021 03:03
Copy link
Contributor

@mhidas mhidas left a 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
Copy link
Contributor

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)
Copy link
Contributor

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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* 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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant