Add a comment for the default value of the rename function.

[Cherry-picked b23da16]
scala · Jun 28, 2024 · 2c8480d · 2c8480d
1 parent 989cf1b
commit 2c8480d
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/compiler/src/dotty/tools/dotc/core/Scopes.scala b/compiler/src/dotty/tools/dotc/core/Scopes.scala
@@ -159,6 +159,7 @@ object Scopes {
 
     /** The scope that keeps only those symbols from this scope that match the
      *  given predicates, renamed with the given rename function.
+     *  If renaming is not needed for a symbol, the rename function should return `null`.
      *  If all symbols match and none are renamed, returns the scope itself, otherwise
      *  a copy with the matching and renamed symbols.
      */