Improve documentation for new_stream_contents().

2020-01-08 21:56:54 +01:00 · 2020-01-08 21:56:54 +01:00 · f401f9d1b2
commit f401f9d1b2
parent 7edcb7c507
1 changed files with 5 additions and 1 deletions
--- a/include/connection.hpp
+++ b/include/connection.hpp
@ -107,7 +107,11 @@ public:
    void set_proxy(string_view proxy);

    /*!
-     *  @brief  Get new stream contents and delete them.
+     *  @brief  Copy new stream contents and delete the “original”.
+     *
+     *  Note that the last event is not necessarily complete, it could happen
+     *  that you are calling this function mid-transfer. You have to check the
+     *  data integrity yourself.
     *
     *  @since  0.1.0
     */