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

Enhance documentation at Restrict #930

Closed
wants to merge 18 commits into from
Closed

Conversation

otaviojava
Copy link
Contributor

I started creating documentation at the Restrict interface when I made a branch to begin implementing it.

The straightforward, precise methods I've created documentation are still a lot of work to go, but it will make sense to break on more PRs since it is considerable work.

Signed-off-by: Otavio Santana <[email protected]>
Signed-off-by: Otavio Santana <[email protected]>
@otaviojava otaviojava requested a review from njr-11 January 6, 2025 20:17
Copy link
Contributor

@njr-11 njr-11 left a comment

Choose a reason for hiding this comment

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

We decided not to add Javadoc and spec doc on Restrictions until we are more certain that the API is where we want it and unlikely to further change. Maybe we are nearly ready to make that decision, but there is currently #915 open for additional changes to the API, which will already make the API out of sync with what you wrote into the very first method of this PR.

Doing a good job on the Javadoc is important because it is how users will come to understand (or not understand) our API and how to use it. This will mean a big investment on our part and should not be done all at once. When it is time, I would expect multiple PRs with work done in smaller chunks, covering only a few classes at a time that we can write and review in depth to ensure we get it all right.

Only looking at the first method here, there is at least one incorrect statement, and it collides with the outstanding PR making further API changes, and it seems oriented toward a Jakarta Data provider rather than a Jakarta Data user. We are not yet ready to invest in the Javadoc. Hopefully soon, but we are not there yet.

@otaviojava otaviojava closed this Jan 7, 2025
@otaviojava otaviojava reopened this Jan 7, 2025
Signed-off-by: Otavio Santana <[email protected]>
@otaviojava otaviojava closed this Jan 7, 2025
@otaviojava otaviojava deleted the enhance-meta-documentation branch January 7, 2025 08:09
@otaviojava
Copy link
Contributor Author

I will close this one and open it as a small documentation step.

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

Successfully merging this pull request may close these issues.

2 participants