Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Documentation fixes #157

Closed
wants to merge 2 commits into from

Conversation

@corpsee
Copy link
Contributor

commented Apr 15, 2016

Documentation fixes

@lindelius

This comment has been minimized.

Copy link

commented May 15, 2016

@jmikola Useful PHPDoc changes that should be merged as soon as possible

@lindelius

This comment has been minimized.

Copy link

commented May 21, 2016

@corpsee Line 102 (after changes) in src/Operation/CreateIndexes.php should actually read:

* @param Server $server

@corpsee

This comment has been minimized.

Copy link
Contributor Author

commented May 23, 2016

@lindelius You are right, thx

jmikola added a commit to jmikola/mongo-php-library that referenced this pull request Jun 3, 2016
@@ -89,6 +100,8 @@ public function execute(Server $server)
* command.
*
* @param Server $server
*
* @return mixed

This comment has been minimized.

Copy link
@jmikola

jmikola Jun 3, 2016

Member

I realized while reviewing that this function's return value is never used. I've removed it entirely in #188.

@jmikola

This comment has been minimized.

Copy link
Member

commented Jun 3, 2016

Thanks for the contribution. I've selected parts of this PR and merged them to v1.0 in bc64127.

To explain why I've omitted other parts of the PR:

  • The doc blocks for private member variables aren't used for generating API documentation. Since these members are internal, I'd prefer to just name them sensibly and keep them self-documenting. In the cases of private static members, those are effectively internal constants whose value is immediately assigned (I don't see the value of prefixing them with /** @var array */ or /** @var int */).
  • I am currently working through refactoring the GridFS component, so its code is in flux. I will be taking a final pass at the documentation for its public API once that refactoring is complete.
@jmikola jmikola closed this Jun 3, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.