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

Reference documentation: Text does not match with code example [DATAMONGO-2457] #3312

Closed
spring-projects-issues opened this issue Jan 17, 2020 · 0 comments

Comments

@spring-projects-issues
Copy link

@spring-projects-issues spring-projects-issues commented Jan 17, 2020

Jesper de Jong opened DATAMONGO-2457 and commented

In the Spring Data MongoDB reference documentation, paragraph 14.2, there is Example 134, with the following code:

public class Person {

  @Id
  private String id;
  private String firstname;
  private String lastname;
  private Address address;

  // … getters and setters omitted
}

The text immediately following this example says:

Note that the domain type shown in the preceding example has a property named id of type ObjectId.

This does not match with the code example - the type of the field id is String and not ObjectId. The text also does not explain the use of the @Id annotation (is it necessary? or is the id field automatically picked up because of its name?).
 


Affects: 2.2.4 (Moore SR4)

Reference URL: https://docs.spring.io/spring-data/mongodb/docs/2.2.4.RELEASE/reference/html/#mongo-repo-usage

Referenced from: pull request #829

Backported to: 2.2.5 (Moore SR5), 2.1.16 (Lovelace SR16)

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

Successfully merging a pull request may close this issue.

None yet
2 participants