Description
Revisions and Commits
Related Objects
Event Timeline
Please, next time, can you paste the text and quote it with triple backquote "`":
it's more readable than to have to click on the screenshot to see the error plus it's nicer to the eyes like this paragraph (or so i think ;)
Thanks.
For your issue, the cli is saying you that there is no --lister option.
Indeed the last improvments introduced in the cli did not report the change in the doc.
That's an oversight on our part.
Nevertheless, you can try to check further the cli next (or the actual module's source if the cli is not clear enough which could happened):
$ python3 -m swh.lister.cli github --help Usage: cli.py [OPTIONS] [github|gitlab|bitbucket|debian|pypi|npm|all]... Initialize db model according to lister. Options: -d, --db-url TEXT SQLAlchemy DB URL; see <http://docs.sqlalchemy.org/en/lat est/core/engines.html#database-urls> -D, --drop-tables Drop tables before creating the database schema --help Show this message and exit.
There is no longer a --create-tables either so the real command in the end is plain:
$ createdb lister-github $ python3 -m swh.lister.cli --db-url postgres:///lister-github github
could you seize that opportunity to report that fixes in the documentation (I see 4 entries that need fixing currently there)?
Ok, next time I will remember this to paste the text and quote it with triple backquote "`".
I would love to fix the documentation as it would be a good starting point in contributing to this project. I am familiar with the process of pull request on Github but new to this forge. Can you guide to on what should I do next?
nice.
I would love to fix the documentation as it would be a good starting point in contributing to this project. I am familiar with the process of pull request on Github but new to this forge.
good, it's not that different.
Can you guide to on what should I do next?
Everything you need to know is explained in the main page [1]
Please take some time to read that page.
The specific part in regards to contribution would be the link targeted on '3. Familiarize yourself with our code review workflow'.
[1] https://wiki.softwareheritage.org/wiki/Google_Summer_of_Code_2019#Before_you_apply
Cheers,
The sample top levels for the different listers are also out of date(as discussed in IRC as well as mentioned by @ardumont in https://forge.softwareheritage.org/D1281). Hence I wish to update the names of those functions in the documentation of lister.