Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#32475 closed Bug (invalid)

datadump and dataload subcommands documentation error

Reported by: Mike Slinn Owned by: nobody
Component: Documentation Version: 3.1
Severity: Normal Keywords:
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

Both the datadump and dataload subcommands have the same documentation error regarding the --database option.

The documentation states that the option “Specifies the database from which data will be dumped. Defaults to default.” Instead, the documentation should say that the option “Specifies the named database entry in settings. Defaults to default.”

Change History (2)

comment:1 by Mariusz Felisiak, 4 years ago

Resolution: invalid
Status: newclosed

Thanks for this ticket, however it's not an error. We use the same wording throughout the docs, see DATABASES docs. IMO it's not misleading and "named" doesn't add much value.

comment:2 by Mike Slinn, 4 years ago

The funny thing about computer documentation is that for someone who is knowledgeable the information as presented is usually obvious. Newcomers, however, have a completely different experience.

Note: See TracTickets for help on using tickets.
Back to Top