chore: tidy up links in some of the phpdoc blocks #319
Conversation
WalkthroughThis pull request updates the PostgreSQL documentation URL references in several PHPDoc comments across the Doctrine DBAL Types and ORM Query AST Functions. All changes modify links from a "current" or HTTP version to reference PostgreSQL version 17 and ensure the use of HTTPS. No code functionality or public API declarations were altered. Changes
Poem
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/ArrayNumberOfDimensions.php (1)
7-11: Review Documentation URL for ARRAY_NDIMS()
The@seeURL has been changed to use HTTPS; however, it now points to PostgreSQL documentation for version 9.6. Since other files reference version 17 for some functionalities, please verify if referencing version 9.6 here is intentional.src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/Unnest.php (1)
7-11: Consistent Documentation URL for UNNEST()
The@seeURL has been updated to HTTPS and points to the PostgreSQL docs for version 9.6. It would be beneficial to confirm that the version used here is correct relative to other parts of the project.src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/ArrayLength.php (1)
7-11: Documentation URL HTTPS Update for ARRAY_LENGTH()
The@seeURL update now uses HTTPS and points to documentation for PostgreSQL version 9.4. Please double-check that this version is the intended target, or update it for consistency with other documentation references if needed.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (14)
src/MartinGeorgiev/Doctrine/DBAL/Types/Cidr.php(1 hunks)src/MartinGeorgiev/Doctrine/DBAL/Types/CidrArray.php(1 hunks)src/MartinGeorgiev/Doctrine/DBAL/Types/DoublePrecisionArray.php(1 hunks)src/MartinGeorgiev/Doctrine/DBAL/Types/Inet.php(1 hunks)src/MartinGeorgiev/Doctrine/DBAL/Types/InetArray.php(1 hunks)src/MartinGeorgiev/Doctrine/DBAL/Types/Macaddr.php(1 hunks)src/MartinGeorgiev/Doctrine/DBAL/Types/MacaddrArray.php(1 hunks)src/MartinGeorgiev/Doctrine/DBAL/Types/RealArray.php(1 hunks)src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/ArrayDimensions.php(1 hunks)src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/ArrayLength.php(1 hunks)src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/ArrayNumberOfDimensions.php(1 hunks)src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/Cast.php(1 hunks)src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/Unaccent.php(1 hunks)src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/Unnest.php(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
- GitHub Check: PHP 8.4 + Doctrine ORM 3.0 + Doctrine Lexer 3.0
- GitHub Check: PHP 8.4 + Doctrine ORM 2.14 + Doctrine Lexer 2.1
- GitHub Check: PHP 8.3 + Doctrine ORM 2.18 + Doctrine Lexer latest
- GitHub Check: PHP 8.3 + Doctrine ORM latest + Doctrine Lexer 3.0
- GitHub Check: PHP 8.2 + Doctrine ORM 3.0 + Doctrine Lexer 3.0
- GitHub Check: PHP 8.1 + Doctrine ORM latest + Doctrine Lexer 3.0
- GitHub Check: PHP 8.1 + Doctrine ORM latest + Doctrine Lexer 2.1
- GitHub Check: PHP 8.1 + Doctrine ORM 2.14 + Doctrine Lexer latest
- GitHub Check: sloth
🔇 Additional comments (11)
src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/Cast.php (1)
16-21: Documentation URL Update for PostgreSQL CAST()
The@seeURL has been updated to reference PostgreSQL version 17, ensuring that users are directed to the current official documentation.src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/Unaccent.php (1)
9-13: Documentation URL Update for UNACCENT()
The@seeURL for PostgreSQL UNACCENT has been updated to use HTTPS and now points to version 17. This change improves security and aligns with the latest docs.src/MartinGeorgiev/Doctrine/DBAL/Types/InetArray.php (1)
10-17: Updated PostgreSQL Documentation URL for INET Array TypeThe PHPDoc comment now references the PostgreSQL 17 documentation for the INET data type. This update aligns with the new standard and improves documentation accuracy without affecting functionality.
src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/ArrayDimensions.php (1)
9-11: Review the PostgreSQL Version in the URLThe documentation URL has been updated to use HTTPS:
@see https://www.postgresql.org/docs/9.6/static/functions-array.htmlHowever, note that while other links have been updated to reference PostgreSQL version 17, this one remains at version 9.6. Please verify if this version is intentional or if it should be similarly updated to version 17 for consistency.
src/MartinGeorgiev/Doctrine/DBAL/Types/Macaddr.php (1)
12-19: Updated Documentation URL for MACADDR Data TypeThe PHPDoc comment for the MACADDR class now points to:
@see https://www.postgresql.org/docs/17/datatype-net-types.html#DATATYPE-MACADDRThis change is a clear improvement in accuracy as it references the PostgreSQL 17 documentation.
src/MartinGeorgiev/Doctrine/DBAL/Types/RealArray.php (1)
7-14: Refreshed Documentation Link for REAL Array TypeThe PHPDoc block now uses the updated URL:
@see https://www.postgresql.org/docs/17/datatype-numeric.htmlThis correctly directs users to the PostgreSQL 17 numeric data type documentation, ensuring consistency with other changes.
src/MartinGeorgiev/Doctrine/DBAL/Types/DoublePrecisionArray.php (1)
7-14: Revised Documentation URL for DOUBLE PRECISION Array TypeThe link is now updated to:
@see https://www.postgresql.org/docs/17/datatype-numeric.htmlThis update aligns with the documentation updates across the codebase, providing accurate and secure reference links.
src/MartinGeorgiev/Doctrine/DBAL/Types/CidrArray.php (1)
13-13: Documentation URL Update for CIDR Array
The PHPDoc@seeannotation has been updated to reference the PostgreSQL version 17 documentation for the CIDR data type. This change is clear, consistent, and non-invasive.src/MartinGeorgiev/Doctrine/DBAL/Types/Inet.php (1)
15-15: Documentation URL Update for INET
The updated@seeannotation now correctly points to the PostgreSQL 17 documentation for the INET data type, ensuring consistency with the overall update.src/MartinGeorgiev/Doctrine/DBAL/Types/MacaddrArray.php (1)
12-12: Documentation URL Update for MACADDR Array
The PHPDoc for the MACADDR[] data type now uses the PostgreSQL version 17 URL, which aligns with the modifications in the other related files.src/MartinGeorgiev/Doctrine/DBAL/Types/Cidr.php (1)
15-15: Documentation URL Update for CIDR
The@seeannotation in the PHPDoc of the CIDR class has been updated to refer to the PostgreSQL 17 documentation, maintaining consistency across the codebase.
Summary by CodeRabbit