artefactual / artefactual/atom-docs
Problem: Bug in CSV export documentation using the CLI
- Dominant language
- Python
- Stars
- 21
- Forks
- 31
- PR merge metrics
- No merged PRs in 30d
Description
Hello!
In https://www.accesstomemory.org/en/docs/2.6/admin-manual/maintenance/cli-import-export/#csv-export-cli-actors the suggested syntax for a CSV export is:
` php symfony csv:authority-export /path/to/my/export-location/example.csv`
This will fail with: `You must specify a valid path`
After some fiddling, I found out that the argument can't be a filename, it must be a directory:
` php symfony csv:authority-export /path/to/my/export-location/`
Ideally, a filename should work, but in the meantime, can the docs reflect this?
Thanks!
Contributor guide
No contributing guide indexed for this repository
Research direction
Open the CSV export CLI documentation at the linked CSV export section and compare the documented command with the working directory-based syntax in the issue. Update the example to use a directory path, then verify that the rendered documentation no longer instructs users to provide a filename.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php, symfony
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100