Skip to content

Readme : adding testing explanations#154

Draft
glelouet wants to merge 1 commit into
phax:masterfrom
glelouet:modif_readme_tests
Draft

Readme : adding testing explanations#154
glelouet wants to merge 1 commit into
phax:masterfrom
glelouet:modif_readme_tests

Conversation

@glelouet
Copy link
Copy Markdown
Contributor

@phax please make a pass to check if that is clear. The goal is to help other people, not make them more confused :D

@phax
Copy link
Copy Markdown
Owner

phax commented May 29, 2026

Looks fine to me. Do you want to add something on top of it?
Shall we add a statement on different Java versions, to use Maven profiles (I know I need to check the switch expression pr...)

@phax phax self-assigned this May 29, 2026
@glelouet glelouet marked this pull request as draft May 29, 2026 19:36
@glelouet
Copy link
Copy Markdown
Contributor Author

glelouet commented May 29, 2026

I think you're right, each feature should be documented. That would go in a dedicated doc/ folder though. Or docs / ? Or keep them at root / with .md to know they are doc ? I rather have them in dedicated folder, even though it makes links more awkard (starting with ../ )
Anyhow I rather have the root README.md cleaner with only simplest, most important things, but I agree that a nice doc goes a long way in helping people use a library more useful.

Now I don't think we should doc each feature about code, as those are better kept up-to-date with tests.
However I think a few features could be made tests for in the new jcodemodel-tests module since that contains both the generating code, and the generated resulting classes.

I made it a draft and will think about it once you give your opinion about the location, and the creation of additional test/example classes. Should I make an issue ? This way we can list what we want.

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