[TASK] Deprecate ParserState::comsumeWhitespace (MyIntervals#670)

Signed-off-by: Daniel Ziegenberg <daniel@ziegenberg.at>
ziegenberg · Aug 25, 2024 · b92f7c3 · b92f7c3
1 parent 62dddaf
commit b92f7c3
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,8 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ### Deprecated
 
+- Deprecate `ParserState::comsumeWhitespace()` in favor of `ParserState::comsumeWhitespaceWithComments()` (#670)
+
 ### Removed
 
 ### Fixed

diff --git a/src/Parsing/ParserState.php b/src/Parsing/ParserState.php
@@ -232,6 +232,14 @@ public function parseCharacter($bIsForIdentifier)
      *
      * @throws UnexpectedEOFException
      * @throws UnexpectedTokenException
+     *
+     * @deprecated From version 9.0.0 onwards this method will be undergo a breaking
+     *      change. This method will no longer consume comments, only whitespace.
+     *      Use `ParserState::comsumeWhitespaceWithComments` as a replacement if you
+     *      need the former behaviour of consuming whitespace and comments.
+     *
+     * @see `ParserState::comsumeWhitespaceWithComments` for a version that also
+     *      returns comments.
      */
     public function comsumeWhitespace(): array
     {