Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update harvester source commands #479

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

frafra
Copy link
Contributor

@frafra frafra commented Nov 16, 2021

README.md does not reflect current options:

Usage: ckan harvester source [OPTIONS] COMMAND [ARGS]...

  Manage harvest sources

Options:
  --help  Show this message and exit.

Commands:
  clear          Clears all datasets, jobs and objects related to a harvest...
  clear-history  If no source id is given the history for all harvest...
  create         Create new harvest source.
  remove         Remove (deactivate) a harvester source, whilst leaving any...
  show           Shows a harvest source.

@seitenbau-govdata
Copy link
Member

seitenbau-govdata commented Nov 29, 2021

@frafra In my opinion the information about the command line CKAN commands in the README.rst in this repository is equal to the commands usage documentation in harvester.py and corresponds to the implementation. Or did I missed something?

@frafra
Copy link
Contributor Author

frafra commented Nov 29, 2021

@frafra In my opinion the information about the command line CKAN commands in the README.rst in this repository is equal to the commands usage documentation in harvester.py and corresponds to the implementation. Or did I missed something?

It does not, from what I see.

@seitenbau-govdata
Copy link
Member

README.md does not reflect current options:

Usage: ckan harvester source [OPTIONS] COMMAND [ARGS]...

  Manage harvest sources

Options:
  --help  Show this message and exit.

Commands:
  clear          Clears all datasets, jobs and objects related to a harvest...
  clear-history  If no source id is given the history for all harvest...
  create         Create new harvest source.
  remove         Remove (deactivate) a harvester source, whilst leaving any...
  show           Shows a harvest source.

You are referencing to a README.md file, but in the repository is only a README.rst file. The file extension differs. And the usage string in harvester.py is different to your pasted excerpt.

@frafra
Copy link
Contributor Author

frafra commented Dec 1, 2021

Both README.rst and the docstring do not reflect what I see from the command line, which is what I posted in the first comment, which is the implementation.

@seitenbau-govdata
Copy link
Member

seitenbau-govdata commented Dec 1, 2021

@frafra I have realized now that you mean the new click commands cli.py in combination with CKAN 2.9. At the moment the README.rst covers only the paster command harvester.py. But they are even more different than only the source command, so I would suggest to add the click commands usage info additionally to the paster command usage info on the README.rst.

@frafra
Copy link
Contributor Author

frafra commented Dec 1, 2021

Sorry for the confusion. My PR is incomplete indeed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants