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

Updating the Getting Started guide's documentation #5677

Closed

Conversation

natechicago
Copy link
Contributor

This pull request contains a number of individual changes, but they all fall into a few common categories:

  • Correcting minor mistakes which, in aggregate, make this document a little more difficult to read than it could otherwise be. These include misspellings, improper casing, grammatical inaccuracies, and run-on sentences.
  • Revising statements/claims that were either accurate at one point but are no longer, or whose imprecise wording leads to unnecessary ambiguity and confusion.
  • Reorganizing a few sections so that terms (like "owning" side vs. "inverse" side) are defined before we assume the reader knows what they mean, and concepts (like Unit of Work) are introduced when they are immediately supported by the neighboring code.
  • Ensuring the sample code is consistent throughout the guide (eg. a property defined initially as 'protected' shouldn't show up as 'private' further down in the guide).
  • Adding entity type hints to setter methods to make the code more expressive.

In its current state, Doctrine's documentation is already quite fantastic. Yet it could still benefit from a little extra polish. I strongly believe that the modifications contained herein will significantly improve the accuracy and readability of the Getting Started guide. This is obviously an important goal, since the Guide is likely the very first point of contact that many new users will have with Doctrine.

@@ -170,15 +170,10 @@ factory method.
Generating the Database Schema
------------------------------

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The statement "Now that we have defined the Metadata mappings" is not accurate. At this point in the tutorial, we haven't defined any metadata mappings yet.

@natechicago natechicago force-pushed the getting-started-updates branch 2 times, most recently from 16f9a39 to 7f280f3 Compare February 24, 2016 20:06
@@ -616,12 +613,13 @@ domain model to match the requirements:
}
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This section regarding ArrayCollection seemed to be incorrect, since no objects of type "Doctrine" are involved here. Please confirm the accuracy of the re-write, though.

@natechicago
Copy link
Contributor Author

@Ocramius is there any appetite for these types of changes from the core Doctrine team? I have some improvements to offer for other sections of the tutorial too, but would like some feedback on this one before submitting them.

@Ocramius Ocramius self-assigned this Jun 21, 2017
@Ocramius Ocramius added this to the 2.6.0 milestone Jun 21, 2017
@Ocramius
Copy link
Member

@Ocramius is there any appetite for these types of changes from the core Doctrine team?

There is, but I really didn't manage to track this one before today, sorry :-(

Keep 'em coming! I'm merging this one after a manual rebase :-)

Thanks for your help!

@Ocramius
Copy link
Member

Manually merged via b925cce

@Ocramius Ocramius closed this in b925cce Jun 21, 2017
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