Merge lp:~kyrofa/unity-scopes-api/1452423_fix-tutorial-typos into lp:unity-scopes-api/devel

[Kyle Fazzari]

Fix a couple typos in the tutorial.

This simply fixes a couple of typos found in the tutorial.

To test:

1) Look at old documentation, and notice the following sentence: "Prior to sending any queries, the scopes run time calls run() if your stop() method completed successfully (did not throw an exception)."

2) Regenerate documentation based on this MP:

$ cmake /path/to/src
$ make doc

3) Open up doc/index.html and notice that the sentence is now: "Prior to sending any queries, the scopes run time calls run() if your start() method completed successfully (did not throw an exception)." A few other smaller typos were also corrected.

[Michi Henning (michihenning)]

Great, thanks for that!

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:328
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/611/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-amd64-ci/145
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/136
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/136/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-i386-ci/137

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/611/rebuild

review: Approve (continuous-integration)

[Michi Henning (michihenning)]

I just realized that you targeted this at trunk, but it really should be devel. Nothing wrong with the MR as such, just the wrong target branch. Can you re-submit for the correct branch please?

review: Needs Fixing

[Kyle Fazzari (kyrofa)]

Of course Michi, sorry about that! I've resubmitted this MP targeting devel.

[Michi Henning (michihenning)]

No need to be sorry. After all, the project description told you to do the wrong thing!

For what it's worth, for unity-scopes-api and thumbnailer, we use devel as a staging branch and periodically take all the changes that have accumulated on the devel branch and bulk-merge them into trunk. From there, the changes go into the archives.

For other projects, the process may well be different. Some projects merge directly into trunk (and do not pass Go...), so you need to check with the project maintainers to find out what the workflow is.

review: Approve

[Kyle Fazzari (kyrofa)]

I can do that. Thanks for the information!

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
No commit message was specified in the merge proposal. Hit 'Add commit message' on the merge proposal web page or follow the link below. You can approve the merge proposal yourself to rerun.
https://code.launchpad.net/~kyrofa/unity-scopes-api/1452423_fix-tutorial-typos/+merge/258490/+edit-commit-message

review: Needs Fixing (continuous-integration)

[Kyle Fazzari (kyrofa)]

Argh... re-submitting wiped my commit message and I missed it. Fixed now.

[Michi Henning (michihenning)]

Splendid! :-)

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'doc/tutorial.dox'
--- doc/tutorial.dox	2015-04-22 13:19:12 +0000
+++ doc/tutorial.dox	2015-05-07 12:37:02 +0000
@@ -181,7 +181,7 @@
 The scopes run time calls \link unity::scopes::ScopeBase::stop() stop()\endlink to inform your scope
 that it should shut down. You can use this method to perform any one-time clean-up.
 
-Prior to sending any queries, the scopes run time calls \link unity::scopes::ScopeBase::run() run()\endlink if your `stop()` method
+Prior to sending any queries, the scopes run time calls \link unity::scopes::ScopeBase::run() run()\endlink if your `start()` method
 completed successfully (did not throw an exception). The `run()` method
 is called by a separate thread that you can use for your own purposes, for example, to run an event loop.
 The scopes run time has no further interest in this thread, but you must ensure that, if you do not return
@@ -191,7 +191,7 @@
 
 \paragraph handlingsearch Handling search
 
-The unity::scopes::ScopeBase::search() method is called once for each query. Its purpose is to instantiante
+The unity::scopes::ScopeBase::search() method is called once for each query. Its purpose is to instantiate
 and return a new C++ instance that encapsulates the query, that is, `search()` is a factory method.
 (Do not start execution of the query as part of `search()`; the query object has a separate method for this.)
 
@@ -295,7 +295,7 @@
 `run()` to execute the query.
 
 The \link unity::scopes::SearchReplyProxy SearchReplyProxy\endlink that is passed to `run()` is an invocation
-handle that allows you push results for the query back towards the client. (`SearchReplyProxy` is a `shared_ptr`
+handle that allows you to push results for the query back towards the client. (`SearchReplyProxy` is a `shared_ptr`
 to a \link unity::scopes::SearchReply SearchReply\endlink object.)
 
 Two important methods of `SerchReply` are \link unity::scopes::SearchReply::register_category register_category()\endlink