Skip to content
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

Minor fixes to the 'getting started' page #6179

Merged
merged 1 commit into from
Dec 23, 2016

Conversation

biggianteye
Copy link
Contributor

  • Use consistent visibility for some fields.
  • Fixing path of yaml file.
  • Minor grammar changes.

@@ -717,8 +717,8 @@ the bi-directional reference:
{
// ... (previous code)

private $reportedBugs = null;
private $assignedBugs = null;
protected $reportedBugs = null;
Copy link
Member

Choose a reason for hiding this comment

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

Should stay private

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Could you explain why? All other instance variables are marked as protected. Why should these two be private?

More importantly, they were declared as protected when first added to the User class. If there is a legitimate need for the change to the visibility, let me know and I'll incorporate it into the section where the visibility changes.

Copy link
Member

Choose a reason for hiding this comment

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

I'd rather have everything as private around the code, but if you think that protected is better for consistency (for now), I can merge the PR as-is.

Should generally strive for private in future.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not trying to advocate one over the other (though if I were, I'd go for private). I'm just trying to remove any confusion caused by modifiers changing half way through introductory documentation without any explanation.

Copy link
Member

Choose a reason for hiding this comment

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

Good, merging as-is then :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

👍

private $reportedBugs = null;
private $assignedBugs = null;
protected $reportedBugs = null;
protected $assignedBugs = null;
Copy link
Member

Choose a reason for hiding this comment

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

Should stay private

@Ocramius Ocramius added this to the 2.6.0 milestone Dec 19, 2016
@Ocramius Ocramius merged commit 22b5fb1 into doctrine:master Dec 23, 2016
@Ocramius Ocramius self-assigned this Dec 23, 2016
@biggianteye biggianteye deleted the getting-started-fixes branch December 23, 2016 10:35
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.

2 participants