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

DOCS-PluginApi:Wording, tense and passive changes (minor). #677

Merged
merged 1 commit into from Aug 29, 2019

Conversation

@josborne777
Copy link
Contributor

commented Aug 26, 2019

Signed-off-by: Jill Osborne techwriterjill@gmail.com

DOCS-PluginApi:Wording, tense and passive changes (minor).
Signed-off-by: josborne777 <techwriterjill@gmail.com>

@josborne777 josborne777 force-pushed the josborne777:DOCS-PluginApi branch from 1428f1c to 8a7cd16 Aug 26, 2019

@gedankenexperimenter
Copy link
Contributor

left a comment

A few nitpicks aside, I think these changes are a big improvement.


Lets start at the top:
This is useful because there are some unorthodox solutions in play that make the code incredibly hard to untangle. It's an unavoidable side effect of employing a system that uses non-virtual functions, which lets us save large amounts of RAM.

This comment has been minimized.

Copy link
@gedankenexperimenter

gedankenexperimenter Aug 26, 2019

Contributor

I think the term "incredibly hard" is a bit hyperbolic. Perhaps "surprisingly hard" would be better. Or even just "difficult", à la Mark Twain's advice…

This comment has been minimized.

Copy link
@algernon

algernon Aug 26, 2019

Member

The term comes from the original, but I do like the suggestion, and "difficult" sounds like a perfect word.

resolve to a function that calls the `foo` method of each plugin we listed
method, `apply`. This is a templated method. The template argument is the
method `apply` calls. Therefore, `EventDispatcher::template apply<foo>`
resolves to a function that calls the `foo` method of each plugin we list

This comment has been minimized.

Copy link
@gedankenexperimenter

gedankenexperimenter Aug 26, 2019

Contributor

There's an extra space in to a here.

The `EventDispatcher` structure has a single method: `apply<>`, which needs an
event handler as its template argument. What the macro does, is call the event
The `EventDispatcher` structure has a single method: `apply<>`, which requires an
event handler as its template argument. The macros calls the event

This comment has been minimized.

Copy link
@gedankenexperimenter

gedankenexperimenter Aug 26, 2019

Contributor

s/macros/macro/

@obra obra merged commit f43ef0b into keyboardio:master Aug 29, 2019

2 checks passed

DCO DCO
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.