Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

[Validator] Add PHPDoc to Isbn attribute class and properties #53424

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from

Conversation

kzorluoglu
Copy link

Q A
Branch? 7.1
Bug fix? no
New feature? no
Deprecations? no
Issues Fix #51920
License MIT

Description:
This PR adds detailed PHPDoc comments to the Isbn class within the Symfony Validator component. These comments include comprehensive descriptions for the class itself, its constructor arguments, and public properties. This enhancement aims to improve the understanding and usability of the Isbn class, especially for developers new to the Symfony framework or this specific component.

src/Symfony/Component/Validator/Constraints/Isbn.php Outdated Show resolved Hide resolved
src/Symfony/Component/Validator/Constraints/Isbn.php Outdated Show resolved Hide resolved
@OskarStark OskarStark changed the title [Validator] Add PHPDoc to Isbn attribute class and properties #51920 [Validator] Add PHPDoc to Isbn attribute class and properties Jan 4, 2024
@OskarStark
Copy link
Contributor

Please make fabbot happy, thanks

kzorluoglu and others added 2 commits January 5, 2024 09:21
Co-authored-by: Oskar Stark <oskarstark@googlemail.com>
Co-authored-by: Oskar Stark <oskarstark@googlemail.com>
@nicolas-grekas
Copy link
Member

This has been done in #52012 so this is a duplicate, sorry.

@kzorluoglu kzorluoglu deleted the validator-attribute-phpdoc branch January 5, 2024 08:30
@kzorluoglu
Copy link
Author

kzorluoglu commented Jan 5, 2024

Are you sure? It's listed here without PR anyway?

#51920

image

@kzorluoglu
Copy link
Author

I checked, it was done before with a little less detail. I think this version is more detailed and understandable. it's your opinion.

@nicolas-grekas
Copy link
Member

I am, see https://github.com/symfony/symfony/pull/52012/files#diff-23dfc0d530e9724ab2f95e5c13915f292bbc6b17413822aa42ded9820183ce89

I think we're going to prefer short descriptions like done in #52012
They're easier to maintain. Longer ones should go to the documentation.

Thanks for submitting anyway!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve PHPDoc descriptions of Attribute classes and parameters
4 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.