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.

Sign up for GitHub

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

Jump to bottom

Improve documentation of environment variable extension #771

Closed
Bukama opened this issue Oct 6, 2023 · 1 comment · Fixed by #773
Closed

Improve documentation of environment variable extension #771

Bukama opened this issue Oct 6, 2023 · 1 comment · Fixed by #773
Assignees
@beatngu13
Labels
⚙️ component: Pioneer Issues about Pioneer own things (e.g. utils) 🚦 status: in progress 📖 theme: documentation 🏗️ type: enhancement

Comments

@Bukama
Copy link
Member

Bukama commented Oct 6, 2023

From time to time (e.g. AWS-Powertools-Lambda-Java-issue 1391) people think that the extension can't be uses with Java 17+, which is not true.

@beatngu13 suggested to somehow improve the documentation, to make this more visible.
@Bukama
Copy link
Member Author

Bukama commented Oct 6, 2023 •
edited

Maybe we can also add a hint/link in the error message or some warning for those who didn't read the documentation? But I'm not sure if we can intervene the standard Java way.

What we surely can do add a notice at the very first part of the documentation and rename the "reflective access" headline to something with "usage in Java 11 / 17 +" or something.

@beatngu13 beatngu13 changed the title Improve documentation of SysEnv-Extension Improve documentation of environment variable extension Oct 6, 2023
@beatngu13 beatngu13 mentioned this issue Oct 6, 2023
Merged
18 tasks
beatngu13 added a commit that referenced this issue Oct 7, 2023
@beatngu13
Improve environment variable extension for Java 17+ (#771 / #773)
e9065d1 
This PR improves the environment variable extension for use with Java
17+. That is, better documentation and warnings as well as errors when
it comes to handling strong encapsulation of the JDK.

Closes: #771
PR: #773
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@beatngu13 beatngu13

Labels
⚙️ component: Pioneer Issues about Pioneer own things (e.g. utils) 🚦 status: in progress 📖 theme: documentation 🏗️ type: enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve environment variable extension for Java 17+ junit-pioneer/junit-pioneer
2 participants
@Bukama @beatngu13