Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update doc for overrideParameters #524

Merged
merged 1 commit into from
Aug 29, 2019
Merged

Update doc for overrideParameters #524

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions src/main/scala/org/scalacheck/Properties.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,16 @@ class Properties(val name: String) {
private val props = new scala.collection.mutable.ListBuffer[(String,Prop)]

/**
* Changes to the test parameters that are specific to this class.
* Can be used to set custom parameter values for this test.
* Customize the parameters specific to this class.
*
* After the command-line (either [[main]] above or sbt) modifies
* the default parameters, this method is called with the current
* state of the parameters. This method must then return
* parameters. The default implementation returns the parameters
* unchanged. However, a user can override this method in a
* properties subclass. Their method can modify the parameters.
* Those parameters will take precedence when the properties are
* executed.
*/
def overrideParameters(p: Test.Parameters): Test.Parameters = p

Expand Down