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

questions on np1sec_api.md #41

Closed
florianap opened this issue Dec 19, 2016 · 1 comment
Closed

questions on np1sec_api.md #41

florianap opened this issue Dec 19, 2016 · 1 comment

Comments

@florianap
Copy link
Contributor

questions on https://github.com/equalitie/np1sec/blob/api-docs/doc/np1sec_api.md

  • line 33: Once the process of creating a conversation is finished, the user is announced through the RoomInterface::conversation_created callback.

    Formerly "the user is let known" -- is "announced" correct? Or should it maybe "presented"/"introduced"?

  • line 149: "To stay independent from the event loop it is used in as much as possible, users
    of the library are required to implement few timer related function" -- what is "it" in "the event loop it is used in"?

  • line 176: unlike the other 2 bullet points, this doesn't see to be an event. can you confirm it shouldn't be rephrased?

@inetic
Copy link
Member

inetic commented Dec 19, 2016

  • line 33: "announced" isn't correct here. The "user" is known prior to the conversation_created callback (it is "myself"). Instead the callbacks tells the user that the conversation which he/she started creating has now been created.

  • line 149: Yeah, it should have been: "To stay independent from the event loop it is used in (as much as possible), users of the library are..."

  • This shouldn't be rephrased. But I shouldn't have used "Right after...", instead it should be "After ..." in both, the first and third bullets.

@inetic inetic closed this as completed Dec 22, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants