trello-php icon indicating copy to clipboard operation
trello-php copied to clipboard

Updating docs

Open andykirk opened this issue 7 years ago • 3 comments

Hi, I'm opening this issue to discuss any queries I have while I update the docs as previously discussed.

First off, the following ApiMethodsTrait methods do not appear in API-GUIDE.md

getCurrentUser
getCurrentUserBoards
getCurrentUserPinnedBoards
getCurrentUserCards
getCurrentUserOrganizations

I'd like to check if there was any reason for that?

Cheers

andykirk avatar Apr 06 '18 12:04 andykirk

Also, the following methods listed in API-GUIDE.md do not appear in the ApiMethodsTrait $methods array.

getAuthorizationUrl
addBatchUrl
getBatchUrls

Edit - I'm guessing these discrepancies are just a result of the $methods being updated ahead of the docs so they're out of sync, but I just wanted to check there wasn't any other reason.

andykirk avatar Apr 06 '18 12:04 andykirk

The 'getCurrent...' methods may truly be an oversight.

The second set of methods you mentioned are implemented from two different traits included in the Trello client class. The ApiMethodsTrait is not exhaustive; it does most of the heavy lifting for basic requests that require additional handling.

stevenmaguire avatar Apr 06 '18 13:04 stevenmaguire

Ahhh, of course! Thanks.

andykirk avatar Apr 06 '18 13:04 andykirk