Comments in parse_ini_file
Nobody has claimed this yet.
- Dominant language
- XML
- Stars
- 596
- Forks
- 890
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 55
Description
I stumbled upon this "feature" concerning how parse_ini_file (and parse_ini_string) handles comments. For the longest time I thought comments started with a semi-colon, After all, that's how it's done in php.ini and the sample in Example # 1 for parse_ini_file states:
; Comments start with ';', as in php.ini
But recently I noticed that Example # 5 has an in-line comment:
quoted = "She said \"Exactly my point\"." ; Results in a string with quote marks in it.
So I tested that, and much to my surprise, inline-comments are indeed supported by parse_ini_file and parse_ini_string. It might be helpful to make that a bit more clear and/or update the line in example # 1 stating that comments typically start with a semi-colon (but not always).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the parse_ini_file documentation and compare Example #1 with Example #5, then check the corresponding parse_ini_string documentation if it describes comments separately. Clarify that inline comments are supported and ensure the examples and comment guidance agree; the documentation is done when readers are not misled about comment placement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100