sharanggupta opened a new pull request, #661:
URL: https://github.com/apache/commons-configuration/pull/661

   Fixes 
[CONFIGURATION-774](https://issues.apache.org/jira/browse/CONFIGURATION-774) 
and 
[CONFIGURATION-729](https://issues.apache.org/jira/browse/CONFIGURATION-729).
   
   **What**
   
   Several code samples in the user guide do not compile:
   
   - *Properties files, Lists and arrays* (CONFIGURATION-774) declares 
`FileBasedConfigurationBuilder<Configuration>`, but the type parameter of 
`FileBasedConfigurationBuilder` is bound to `FileBasedConfiguration`, and the 
`configure(...)` call misses its closing parenthesis.
   - *Composite configuration* has the same 
`FileBasedConfigurationBuilder<Configuration>` in two samples. The in-memory 
configuration sample calls `Configuration.get(String)`, which does not exist, 
and its `for` header misses the second semicolon.
   - *Quick start* (CONFIGURATION-729) introduces the file as 
`database.properties` but reads `config.properties` in the code.
   
   **How**
   
   The builders use `FileBasedConfigurationBuilder<PropertiesConfiguration>`, 
as other pages of the guide already do. The missing parenthesis and semicolon 
are added, `getProperty(key)` replaces `get(key)`, and the quick start reads 
`database.properties`.
   
   I compiled the corrected samples against the current classes, and the 
default `mvn` goal passes locally on Java 17.
   
   Before you push a pull request, review this list:
   
   - [x] Read the [contribution guidelines](CONTRIBUTING.md) for this project.
   - [x] Read the [ASF Generative Tooling 
Guidance](https://www.apache.org/legal/generative-tooling.html) if you use 
Artificial Intelligence (AI).
   - [x] I used AI to create any part of, or all of, this pull request. Which 
AI tool was used to create this pull request, and to what extent did it 
contribute? Claude (Anthropic) helped find the compile errors and draft the 
fixes; I reviewed them and compiled the corrected samples.
   - [x] Run a successful build using the default 
[Maven](https://maven.apache.org/) goal with `mvn`; that's `mvn` on the command 
line by itself.
   - [ ] Write unit tests that match behavioral changes, where the tests fail 
if the changes to the runtime are not applied. This may not always be possible, 
but it is a best practice.
   - [x] Write a pull request description that is detailed enough to understand 
what the pull request does, how, and why.
   - [x] Each commit in the pull request should have a meaningful subject line 
and body. Note that a maintainer may squash commits during the merge process.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to