Provide better documentation for provideDummy/provideDummyBuilder
#754
Conversation
Mostly fixes dart-lang#697. I'm still not quite satisfied with the documentation for `provideDummyBuilder` since the `DummyBuilder` `typedef` remains undocumented, but I can't write documentation for that because I don't understand its arguments.
jamesderlin
force-pushed
the
jamesderlin/doc-dummy
branch
from
fa9b56e
to
187d88f
Compare
|
@srawlins Could you take a look when you have a chance? |
| @@ -203,3 +203,71 @@ targets: | |||
| ``` | |||
|
|
|||
| Also, you can also check out the example configuration in the Mockito repository. | |||
|
|
|||
|
|
|||
| ## How do I mock a `sealed` class? | |||
There was a problem hiding this comment.
This section discusses how to mock a class that requires instances of sealed classes, rather that mocking sealed classes.
There was a problem hiding this comment.
Oops. Heh, I even made a similar correction to a StackOverflow question about this.
I also updated the URLs referring to this section. I feel that the new heading is too long and is more brittle (and I don't think GitHub Markdown supports generating custom slugs?), so I've changed the URLs to be a bit less specific.
FAQ.md
Outdated
| } | ||
| ``` | ||
|
|
||
| and now you want to mock `Foo`. The generated implementation for `MockFoo` |
There was a problem hiding this comment.
I think this is a bit of a leap from wanting to mock Foo to having a generated implementation. Maybe something like, "A mock implementation of Foo, generated by @GenerateNiceMocks([MockSpec<Foo>()]), needs to ..."
There was a problem hiding this comment.
I do like that better. Fixed.
FAQ.md
Outdated
| class _FakeBar extends Fake implements Bar {} | ||
| ``` | ||
|
|
||
| And then the generated implementation of `MockFoo` can have its `someMethod` |
There was a problem hiding this comment.
It's not really an "implementation" of MockFoo; you could say the generated declaration of MockFoo or maybe the generated mock implementation of Foo.
There was a problem hiding this comment.
Argh, yeah, I didn't mean "implementation" in the Dart implements sense. I will just remove "the generated implementation of".
| @@ -156,7 +157,8 @@ T dummyValue<T>(Object parent, Invocation invocation) { | |||
| throw MissingDummyValueError(T); | |||
| } | |||
|
|
|||
| /// Provide a builder for that could create a dummy value of type `T`. | |||
| /// Specifies a builder to create a dummy value of type `T`. | |||
Mostly fixes #697.
I'm still not quite satisfied with the documentation for
provideDummyBuildersince theDummyBuildertypedefremains undocumented, but I can't write documentation for that because I don't understand its arguments.