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

Rename CLI analyze command to suggest #267

Closed
osma opened this issue Apr 5, 2019 · 2 comments · Fixed by #270
Closed

Rename CLI analyze command to suggest #267

osma opened this issue Apr 5, 2019 · 2 comments · Fixed by #270
Milestone

Comments

@osma
Copy link
Member

osma commented Apr 5, 2019

I'd like to rename the analyze CLI command (and also the REST method, but that's a separate issue) into suggest, following the example of the Maui Server API which has a similar method.

I realize this may break existing uses, but hey, Annif is still in 0.x versions where breakage is expected, and if you're going to do it it's better to do this early. I've never been very happy with the analyze command name, for example because it clashes with the concept of Analyzers which are just the first part of the operation.

After the change the wiki documentation needs to be updated as well.

@osma osma added this to the Short term milestone Apr 5, 2019
@osma
Copy link
Member Author

osma commented Apr 5, 2019

The analyzedir command could be renamed to index in the same go.

Within the codebase, all methods named like analyze could be renamed suggest.

@osma
Copy link
Member Author

osma commented Apr 5, 2019

AnalysisHit and AnalysisResult need to be renamed as well for consistency. SubjectSuggestion and SuggestionResult maybe?

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

Successfully merging a pull request may close this issue.

1 participant