Skip to content

Comments

Replace "attribute" with "argument" to avoid confusion with PHP attributes#2741

Merged
GromNaN merged 1 commit intodoctrine:2.11.xfrom
GromNaN:doc-parameter
Mar 4, 2025
Merged

Replace "attribute" with "argument" to avoid confusion with PHP attributes#2741
GromNaN merged 1 commit intodoctrine:2.11.xfrom
GromNaN:doc-parameter

Conversation

@GromNaN
Copy link
Member

@GromNaN GromNaN commented Mar 3, 2025

Q A
Type doc
BC Break no
Fixed issues Fix #2691

Summary

I prefer the word "parameter" as it's more a configuration than a method calls. For me "argument" refers to the definition in the method signature, and "parameter" to the value in the method call.

I kept the word "attribute" in the "xml-mappings" page as this is the correct word for XML tags.

Also improving examples and wording for "type", as the mapping from PHP property type to MongoDB Field type should be used by default for simplicity.
And a new paragraph about the date fields specifically, I think that was missing for newcomers that may make the mistake of storing dates as string.

@GromNaN GromNaN requested review from alcaeus and jmikola March 3, 2025 21:56
@GromNaN GromNaN changed the title Replace attribute with parameter to avoid confusion with PHP attributes Replace "attribute" with "argument" to avoid confusion with PHP attributes Mar 3, 2025
Copy link
Member

@alcaeus alcaeus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree with the change from "attribute" to "argument" to reduce confusion. I'll let @jmikola take a look at the wording of the "Date Fields" section, but so far: LGTM.

@GromNaN GromNaN requested review from alcaeus and jmikola March 4, 2025 14:29
@GromNaN GromNaN changed the base branch from 2.10.x to 2.11.x March 4, 2025 15:02
@GromNaN GromNaN merged commit 123ab7d into doctrine:2.11.x Mar 4, 2025
4 of 20 checks passed
@GromNaN GromNaN deleted the doc-parameter branch March 4, 2025 18:17
@GromNaN GromNaN added this to the 2.11.0 milestone Mar 6, 2025
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.

Fix wording in attribute reference

3 participants