Merge pull request #281 from eseiler/doc/version_check

[DOC] Update version check doc

Author: eseiler

doc/about/update_notifications/index.md

@@ -21,8 +21,10 @@ have fewer bugs, and we receive fewer bug reports on outdated versions.
 Upon starting an application using the `sharg::parser`, it is determined whether the app was built in release
 mode (we assume a user is running it) or in debug mode (we assume the developer is running it).
 
-We then send a web-request to our server with the following information:
+The user/developer is then asked whether they want to perform a version check. The default answer, which is also used
+if the terminal is not interactive, is to skip the version check.
 
+If the user/developer agrees, we then send a web-request to our server with the following information:
  * The application name
  * The application version
  * The Sharg version that the application was built with
@@ -38,6 +40,8 @@ Additionally, we recommend registering your app with us ([email protected]).
 
 ## Privacy Implications
 
+**No data is transmitted unless the user _explicitly_ allows it.**
+
 Only the information listed above is transmitted; no data is gathered about the usage of the app, and, of course, no
 information regarding your input/output files is transmitted. All our code is open source, and hence this can be
 verified at any time.
@@ -63,3 +67,6 @@ variable `SHARG_NO_VERSION_CHECK` to any value.
 Application developers may opt out of the version check for their app permanently (independent of user choice) by
 passing `sharg::update_notifications::off` as the fourth argument to sharg::parser.
 See the respective API documentation of the `sharg::parser`.
+
+Note that `sharg::update_notifications::on` does not mean that the version check is performed, but rather that the
+application is allowed to perform the version check if the user chooses to do so.

include/sharg/auxiliary.hpp

@@ -19,6 +19,7 @@ namespace sharg
 
 /*!\brief Indicates whether application allows automatic update notifications by the sharg::parser.
  * \ingroup misc
+ * \sa https://docs.seqan.de/sharg/main_user/about_update_notifications.html
  * \details
  * \stableapi{Since version 1.0.}
  */