100% doc coverage #616

Merged
merged 6 commits into from Mar 6, 2014

Conversation

Projects
None yet
5 participants
@xaviershay
Member

xaviershay commented Mar 1, 2014

@samphippen I wasn't sure what to do with the remaining any instance stuff, could you please have a look?

Undocumented Objects:

(in file: lib/rspec/mocks/any_instance/chain.rb)
RSpec::Mocks::AnyInstance
RSpec::Mocks::AnyInstance::Chain::Customizations
RSpec::Mocks::AnyInstance::Chain::Customizations.record
RSpec::Mocks::AnyInstance::Chain

(in file: lib/rspec/mocks/configuration.rb)
RSpec::Mocks::Configuration#yield_receiver_to_any_instance_implementation_blocks=

@myronmarston

Fixes #585

@arthurnn

This comment has been minimized.

Show comment
Hide comment
@arthurnn

arthurnn Mar 1, 2014

Contributor

Why this change? as far as I understand the difference, @api private should be used, so public class/methods will be marked as private API, instead of hidden them on the docs.

Contributor

arthurnn commented on 22850ac Mar 1, 2014

Why this change? as far as I understand the difference, @api private should be used, so public class/methods will be marked as private API, instead of hidden them on the docs.

This comment has been minimized.

Show comment
Hide comment
@myronmarston

myronmarston Mar 1, 2014

Member

These methods are not relevant to the intended audience of our published API docs. Including them adds tons of noise to the docs.

Member

myronmarston replied Mar 1, 2014

These methods are not relevant to the intended audience of our published API docs. Including them adds tons of noise to the docs.

This comment has been minimized.

Show comment
Hide comment
@JonRowe

JonRowe Mar 2, 2014

Member

👍

Member

JonRowe replied Mar 2, 2014

👍

@myronmarston

This comment has been minimized.

Show comment
Hide comment
@myronmarston

myronmarston Mar 2, 2014

Member

These changes all look good to me. We can always merge this as-is and then address the last few undoc'd things.

There's also these warnings from YARD:

➜  rspec-mocks git:(issue-585) bin/yard stats --list-undoc
[warn]: Unknown tag @public in file `lib/rspec/mocks/error_generator.rb` near line 5
[warn]: Unknown tag @public in file `lib/rspec/mocks/error_generator.rb` near line 10
[warn]: Unknown tag @public in file `lib/rspec/mocks/error_generator.rb` near line 14
[warn]: @param tag has unknown parameter name: name
    in file `lib/rspec/mocks/example_methods.rb' near line 34
[warn]: @param tag has unknown parameter name: stubs
    in file `lib/rspec/mocks/example_methods.rb' near line 34
[warn]: @param tag has unknown parameter name: stubs
    in file `lib/rspec/mocks/example_methods.rb' near line 48
[warn]: @param tag has unknown parameter name: stubs
    in file `lib/rspec/mocks/example_methods.rb' near line 63
[warn]: @param tag has unknown parameter name: stubs
    in file `lib/rspec/mocks/example_methods.rb' near line 78
[warn]: @param tag has unknown parameter name: *expected_args
    in file `lib/rspec/mocks/argument_list_matcher.rb' near line 46
[warn]: @param tag has unknown parameter name: block
    in file `lib/rspec/mocks/argument_list_matcher.rb' near line 46
[warn]: @param tag has unknown parameter name: *args
    in file `lib/rspec/mocks/argument_list_matcher.rb' near line 63
[warn]: Unknown tag @override in file `lib/rspec/mocks/verifying_message_expecation.rb` near line 27

Would be cool to address those at the same time but that's definitely not a merge blocker.

I just kicked the build (which had a transient bundler failure). @xaviershay feel free to merge this whenever. We should #585 open until we hit 100% (and have the build fail if we don't stay at 100%), though.

Member

myronmarston commented Mar 2, 2014

These changes all look good to me. We can always merge this as-is and then address the last few undoc'd things.

There's also these warnings from YARD:

➜  rspec-mocks git:(issue-585) bin/yard stats --list-undoc
[warn]: Unknown tag @public in file `lib/rspec/mocks/error_generator.rb` near line 5
[warn]: Unknown tag @public in file `lib/rspec/mocks/error_generator.rb` near line 10
[warn]: Unknown tag @public in file `lib/rspec/mocks/error_generator.rb` near line 14
[warn]: @param tag has unknown parameter name: name
    in file `lib/rspec/mocks/example_methods.rb' near line 34
[warn]: @param tag has unknown parameter name: stubs
    in file `lib/rspec/mocks/example_methods.rb' near line 34
[warn]: @param tag has unknown parameter name: stubs
    in file `lib/rspec/mocks/example_methods.rb' near line 48
[warn]: @param tag has unknown parameter name: stubs
    in file `lib/rspec/mocks/example_methods.rb' near line 63
[warn]: @param tag has unknown parameter name: stubs
    in file `lib/rspec/mocks/example_methods.rb' near line 78
[warn]: @param tag has unknown parameter name: *expected_args
    in file `lib/rspec/mocks/argument_list_matcher.rb' near line 46
[warn]: @param tag has unknown parameter name: block
    in file `lib/rspec/mocks/argument_list_matcher.rb' near line 46
[warn]: @param tag has unknown parameter name: *args
    in file `lib/rspec/mocks/argument_list_matcher.rb' near line 63
[warn]: Unknown tag @override in file `lib/rspec/mocks/verifying_message_expecation.rb` near line 27

Would be cool to address those at the same time but that's definitely not a merge blocker.

I just kicked the build (which had a transient bundler failure). @xaviershay feel free to merge this whenever. We should #585 open until we hit 100% (and have the build fail if we don't stay at 100%), though.

@samphippen

This comment has been minimized.

Show comment
Hide comment
@samphippen

samphippen Mar 2, 2014

Member

@xaviershay cool if I write some docs and push them at this branch?

Member

samphippen commented Mar 2, 2014

@xaviershay cool if I write some docs and push them at this branch?

@xaviershay

This comment has been minimized.

Show comment
Hide comment
Member

xaviershay commented Mar 2, 2014

@samphippen do it

@xaviershay

This comment has been minimized.

Show comment
Hide comment
@xaviershay

xaviershay Mar 2, 2014

Member

Not sure how to fix the example_methods.rb warnings ... I want to keep *args because we're passing it straight through to another method.

Member

xaviershay commented Mar 2, 2014

Not sure how to fix the example_methods.rb warnings ... I want to keep *args because we're passing it straight through to another method.

@samphippen

This comment has been minimized.

Show comment
Hide comment
@samphippen

samphippen Mar 3, 2014

Member

@xaviershay I'm going to get to this tomorrow morning my time. Should be ready by the time you're awake tomorrow your time.

Member

samphippen commented Mar 3, 2014

@xaviershay I'm going to get to this tomorrow morning my time. Should be ready by the time you're awake tomorrow your time.

@samphippen

This comment has been minimized.

Show comment
Hide comment
@samphippen

samphippen Mar 4, 2014

Member

@myronmarston @xaviershay do you think the module RSpec::Mocks::AnyInstance should be marked @private. I think yes, everything in there is pretty implementation specific.

Member

samphippen commented Mar 4, 2014

@myronmarston @xaviershay do you think the module RSpec::Mocks::AnyInstance should be marked @private. I think yes, everything in there is pretty implementation specific.

@myronmarston

This comment has been minimized.

Show comment
Hide comment
@myronmarston

myronmarston Mar 4, 2014

Member

@myronmarston @xaviershay do you think the module RSpec::Mocks::AnyInstance should be marked @Private. I think yes, everything in there is pretty implementation specific.

Yes.

Member

myronmarston commented Mar 4, 2014

@myronmarston @xaviershay do you think the module RSpec::Mocks::AnyInstance should be marked @Private. I think yes, everything in there is pretty implementation specific.

Yes.

@samphippen

This comment has been minimized.

Show comment
Hide comment
@samphippen

samphippen Mar 4, 2014

Member

@xaviershay I think I've done all the anyinstance docs now. Let me know if you'd like anything extra

Member

samphippen commented Mar 4, 2014

@xaviershay I think I've done all the anyinstance docs now. Let me know if you'd like anything extra

@xaviershay

This comment has been minimized.

Show comment
Hide comment
@xaviershay

xaviershay Mar 6, 2014

Member

Merging. As noted, don't know what to do about the example method warnings.

Assuming that rspec-dev changes will end up enforcing this in the build and that I don't need to worry about that part.

> yard stats --list-undoc
[warn]: @param tag has unknown parameter name: name
    in file `lib/rspec/mocks/example_methods.rb' near line 34
[warn]: @param tag has unknown parameter name: stubs
    in file `lib/rspec/mocks/example_methods.rb' near line 34
[warn]: @param tag has unknown parameter name: stubs
    in file `lib/rspec/mocks/example_methods.rb' near line 48
[warn]: @param tag has unknown parameter name: stubs
    in file `lib/rspec/mocks/example_methods.rb' near line 63
[warn]: @param tag has unknown parameter name: stubs
    in file `lib/rspec/mocks/example_methods.rb' near line 78
Files:          16
Modules:        10 (    0 undocumented)
Classes:         7 (    0 undocumented)
Constants:       4 (    0 undocumented)
Methods:        73 (    0 undocumented)
 100.00% documented
Member

xaviershay commented Mar 6, 2014

Merging. As noted, don't know what to do about the example method warnings.

Assuming that rspec-dev changes will end up enforcing this in the build and that I don't need to worry about that part.

> yard stats --list-undoc
[warn]: @param tag has unknown parameter name: name
    in file `lib/rspec/mocks/example_methods.rb' near line 34
[warn]: @param tag has unknown parameter name: stubs
    in file `lib/rspec/mocks/example_methods.rb' near line 34
[warn]: @param tag has unknown parameter name: stubs
    in file `lib/rspec/mocks/example_methods.rb' near line 48
[warn]: @param tag has unknown parameter name: stubs
    in file `lib/rspec/mocks/example_methods.rb' near line 63
[warn]: @param tag has unknown parameter name: stubs
    in file `lib/rspec/mocks/example_methods.rb' near line 78
Files:          16
Modules:        10 (    0 undocumented)
Classes:         7 (    0 undocumented)
Constants:       4 (    0 undocumented)
Methods:        73 (    0 undocumented)
 100.00% documented

xaviershay added a commit that referenced this pull request Mar 6, 2014

@xaviershay xaviershay merged commit dbd5533 into master Mar 6, 2014

1 check passed

default The Travis CI build passed
Details
@myronmarston

This comment has been minimized.

Show comment
Hide comment
@myronmarston

myronmarston Mar 6, 2014

Member

As noted, don't know what to do about the example method warnings.

I've opened a yard ticket: lsegal/yard#746

Member

myronmarston commented Mar 6, 2014

As noted, don't know what to do about the example method warnings.

I've opened a yard ticket: lsegal/yard#746

@JonRowe JonRowe deleted the issue-585 branch Mar 6, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment