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

Jump to bottom

Fix SDLAlert documentation #1233

Closed
NicoleYarroch opened this issue Apr 11, 2019 · 1 comment
Closed

Fix SDLAlert documentation #1233

NicoleYarroch opened this issue Apr 11, 2019 · 1 comment
Assignees
@justingluck93
Labels
documentation Relating to inline documentation
Projects
v6.3

Comments

@NicoleYarroch
Copy link
Contributor

NicoleYarroch commented Apr 11, 2019 •
edited

Bug Report

The SDL_iOS library documentation for SDLAlert is inaccurate. Currently it says:

Although each Alert parameter is optional, in fact each SDLAlert request must supply at least one of the following parameters:
alertText1
alertText2
alertText3
ttsChunks

However, the RPC spec says

At least either alertText1, alertText2 or TTSChunks need to be provided.

OS & Version Information
  • iOS Version: n/a
  • SDL iOS Version: 6.1
  • Testing Against: n/a
@NicoleYarroch NicoleYarroch added bug A defect in the library documentation Relating to inline documentation and removed bug A defect in the library labels Apr 11, 2019
@justingluck93 justingluck93 mentioned this issue Apr 25, 2019
Merged
1 task
@theresalech
Copy link
Contributor

Fixed via #1242

@NicoleYarroch NicoleYarroch added this to To do in v6.3 via automation Apr 25, 2019
@NicoleYarroch NicoleYarroch moved this from To do to Done in v6.3 Apr 25, 2019
@joeljfischer joeljfischer mentioned this issue May 8, 2019
Merged
1 task
@joeljfischer joeljfischer mentioned this issue Jun 24, 2019
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@justingluck93 justingluck93

Labels
documentation Relating to inline documentation
Projects
No open projects
v6.3
  
Done
Milestone
No milestone
Development

No branches or pull requests
3 participants
@NicoleYarroch @theresalech @justingluck93