Skip to content
This repository was archived by the owner on Oct 26, 2026. It is now read-only.

Revisions on the revisionson on view-javadoc - #54

Merged
ctrueden merged 9 commits into
mainfrom
scijava/scijava-ops-engine/view-javadoc-revisions-revisions
Jul 1, 2022
Merged

ctrueden merged 9 commits into
mainfrom
scijava/scijava-ops-engine/view-javadoc-revisions-revisions

Conversation

@gselzer

@gselzer gselzer commented Jan 21, 2022

Copy link
Copy Markdown
Member

Addresses the revisions requested in #47

@ctrueden
ctrueden force-pushed the scijava/scijava-ops-engine/view-javadoc-revisions-revisions branch from 325a71e to 5a09cbd Compare July 1, 2022 21:48

@ctrueden ctrueden left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

A few small comments again, but merging proceeds! Keep up the good work @gselzer, you got this!

final OpDependency annotation)
{
this(() -> key, () -> description, type, annotation);
this.key = key;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This looks like more than just "cleaning" to me. A better commit message explaining what this commit actually does would have been nice.

return type;
}
}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Trailing newline.

String getKey();

/** Description of the member. */
/** Non-null description. The default description is an empty string */

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Second sentence needs a period.

// will be written to, but immutable parameters cannot be changed in
// such a manner, so it makes no sense to label them as such.
final String error = "Immutable " + m.getIOType() + " parameter: " +
name.get() + " (" + type.getName() + " is immutable)";

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

To be fair, we are only calling the supplier when there is an error. So, there is a chance that performance could be impacted. But the fact that the only supplier is just m.getKey() and presumably that's O(1), with no additional memory allocation... means that performance is highly unlikely to be a problem here. At least for this use case! But the checkValidity method is public static... should we be concerned in general? Does/will anyone else ever call this? If not: maybe we should make this private? Or if so, maybe the supplier is still a good idea?

@ctrueden
ctrueden merged commit cc307ed into main Jul 1, 2022
@ctrueden
ctrueden deleted the scijava/scijava-ops-engine/view-javadoc-revisions-revisions branch July 1, 2022 22:05
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants