Ensure consistency of methods signatures #245
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yagop
approved these changes
Jan 6, 2017
|
I also suggest:
Should I proceed to include the above additions? |
Bug:
The library assumes signatures of methods to be, somewhat:
methodName(requiredParam1, requiredParam2, form = {})
where 'requiredParam1' ('requiredParam2', ..., 'requiredParamN')
are parameters that MUST be provided, and
'form' is an optional object allowing supplying any additional,
optional parameters that the Bot API allows.
This allows any new parameters added by Telegram to be
readily-supported by our library.
GochoMugo
force-pushed
the
fix/methods-consistency
branch
from
b71e553 to
e6cfe90
Compare
Current coverage is 79.28% (diff: 87.50%)@@ master #245 diff @@
==========================================
Files 3 3
Lines 538 560 +22
Methods 97 97
Messages 0 0
Branches 100 111 +11
==========================================
+ Hits 424 444 +20
- Misses 114 116 +2
Partials 0 0
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Bug:
The library assumes signatures of methods to be, somewhat:
where
requiredParam1(requiredParam2, ...,requiredParamN)are parameters that MUST be provided, and
formis an optional object allowing supplying any additional,optional parameters that the Bot API allows.
This allows any new parameters added by Telegram to be
readily-supported by our library.
Notes:
This fix is backwards-compatible; while we should
notify the community of the change in method signatures,
old code using the old method signatures will not
break.
In the future, when we decide to release a major release
(i.e. bump major version), we could remove the code
providing this backwards-compatibility.