Skip to content

Commit

Permalink
Docs++
Browse files Browse the repository at this point in the history
[ci-skip]
  • Loading branch information
nyalldawson committed Mar 5, 2018
1 parent 84cdd60 commit d79221f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 3 additions & 1 deletion python/core/qgsfileutils.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,9 @@ will be returned unchanged.
Converts a ``string`` to a safe filename, replacing characters which are not safe
for filenames with an '_' character.

This method should be called with file names only, not complete paths.
.. warning::

This method strips slashes from the filename, so it is safe to call with file names only, not complete paths.
%End
};

Expand Down
2 changes: 1 addition & 1 deletion src/core/qgsfileutils.h
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ class CORE_EXPORT QgsFileUtils
* Converts a \a string to a safe filename, replacing characters which are not safe
* for filenames with an '_' character.
*
* This method should be called with file names only, not complete paths.
* \warning This method strips slashes from the filename, so it is safe to call with file names only, not complete paths.
*/
static QString stringToSafeFilename( const QString &string );
};
Expand Down

0 comments on commit d79221f

Please sign in to comment.