spring-projects / spring-projects/spring-hateoas
Errors in reference documentation for Traverson CollectionModel section
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 476
- PR merge metrics
- No merged PRs in 30d
Description
There's an error in the reference documentation under 6.1.1 EntityModel<T> vs. CollectionModel<T>
CollectionModelType<Item> collectionModelType =
TypeReferences.CollectionModelType<Item>() {};
This should be using the new keyword:
CollectionModelType<Item> collectionModelType =
new TypeReferences.CollectionModelType<Item>() {};
Additionally, there appears to be a problem with the hyperlinking of the 6.1.1 section. When hovering over the 6.1.1 header, no deep link option appears. Additionally, clicking on the 6.1.1 link in the left sidebar links to the top of the page (the # anchor) rather than the section. It looks like the h4 HTML element for the 6.1.1 section is missing an id, so I'm guessing this is causing both these issues.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Spring HATEOAS reference documentation section 6.1.1, then locate its source in the repository. Verify the CollectionModelType example and the generated heading/sidebar anchor behavior. Done means the example includes the constructor and the 6.1.1 heading links to its section.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100