hibernate-orm icon indicating copy to clipboard operation
hibernate-orm copied to clipboard

Some minor doc corrections

Open jrenaat opened this issue 1 year ago • 3 comments

jrenaat avatar Jan 10 '24 22:01 jrenaat

Thanks for your pull request!

This pull request does not follow the contribution rules. Could you have a look?

❌ All commit messages should start with a JIRA issue key matching pattern HHH-\d+     ↳ Offending commits: [cce74798222617584a67554c7ee44d509655ac12]

› This message was automatically generated.

Instead of removing anchors on which people might already rely on, I suggest you just add additional ones.

Yeah, while this is true Christian, it also leaves the docs littered with either references that are no longer valid or conflicting (case in point, repeated refs) that lead to invalid links that 'clients' of these will most likely stop using or remove anyway, because of that. So your suggestion kinda defeats the purpose of this PR, which was to correct (some of) these problems.

jrenaat avatar Jan 12 '24 17:01 jrenaat

If an anchor is wrong, I agree to remove/replace it, but let's be sensible here, links to these sections (e.g. https://docs.jboss.org/hibernate/orm/5.0/userguide/html_single/Hibernate_User_Guide.html#collections-set) have used these anchors for quite some time and are possibly linked a few times already. Let's not just break peoples links. I think we can deal with the occasional double anchor in our minds for the sake of our users.

beikov avatar Jan 15 '24 11:01 beikov