Added some additional comments to version service. #273
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
jcoyne
reviewed
May 20, 2019
app/services/version_service.rb
Outdated
| @@ -20,10 +20,15 @@ def initialize(work) | |||
| # @option opts [Hash] :vers_md_upd_info If present, used to add to the events datastream and set the desc and significance on the versionMetadata datastream | |||
| # @raise [Dor::Exception] if the object hasn't been accessioned, or if a version is already opened | |||
| def open(opts = {}) | |||
| # Object has been accessioned at least once. | |||
There was a problem hiding this comment.
I'm not sure what this means. Does this mean "this method should only be called on an object that has been accessioned at least once?"
jcoyne
reviewed
May 20, 2019
app/services/version_service.rb
Outdated
| # During local development, we need a way to open a new version even if the object has not been accessioned. | ||
| raise(Dor::Exception, 'Object net yet accessioned') unless | ||
| opts[:assume_accessioned] || Dor::Config.workflow.client.lifecycle('dor', work.pid, 'accessioned') | ||
| # Raised if for the current version, there are are any incomplete wf steps and there is a versionWF. |
There was a problem hiding this comment.
Rephrase "Raised when the current version has any incomplete workflow steps and there is a versionWF"
jcoyne
reviewed
May 20, 2019
app/services/version_service.rb
Outdated
| raise Dor::VersionAlreadyOpenError, 'Object already opened for versioning' if open? | ||
| # Raised if for the current version, there are any incomplete wf steps and there is an accessionWF. | ||
| # The submittedWF is part of the accessionWF. |
There was a problem hiding this comment.
s/submittedWF/submitted milestone
jcoyne
reviewed
May 20, 2019
app/services/version_service.rb
Outdated
| raise Dor::VersionAlreadyOpenError, 'Object already opened for versioning' if open? | ||
| # Raised if for the current version, there are any incomplete wf steps and there is an accessionWF. |
There was a problem hiding this comment.
Can this be rephrased to "Raised when the current version has any incomplete workflow steps and there is an accessionWF"
justinlittman
force-pushed
the
version_comments
branch
from
f4759de
to
831e9b5
Compare
|
@jcoyne Fixed all. |
jcoyne
approved these changes
May 20, 2019
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.
No description provided.