separate minimization part #24
Merged
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
kelloggm
requested changes
Sep 28, 2023
| /** | ||
| * This method provides a simplified way for users to perform the minimization job using Specimin. | ||
| * Users can call this method directly instead of invoking the main method of Specimin to initiate | ||
| * the minimization process. |
There was a problem hiding this comment.
This comment needs to mention that this is intended as an API for users who want to use Specimin as part of their own project. You've got most of that in the comment, but you should come out and say it directly. In particular, the phrases "API" and "use Specimin as a library" both need to appear, because those are what potential users will search for.
|
Professor, I have updated the javadoc. |
kelloggm
approved these changes
Sep 28, 2023
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.
Professor, this is the PR to separate the main method of SpeciminRunner as we've discussed. Please let me know if there is anything I need to change.