The comment above is better placed in the part of the function that deals with the issue as the documentation of the function.