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 command analyze to suggest and refactor method names #270

Merged
merged 13 commits into from
Apr 17, 2019

Conversation

osma
Copy link
Member

@osma osma commented Apr 5, 2019

This PR changes the analyze command to suggest and the analyzedir command to index. Many methods, variable names, docstrings, comments and even some module names within the codebase are renamed.

This is mainly a terminological change, to avoid the word analyze which hereafter is only used for the preprocessing performed by Analyzers, and to introduce the word suggest when referring to the full subject indexing operation where subjects are suggested for a given document.

Fixes #267

@osma osma added this to the v0.40 milestone Apr 5, 2019
@codecov
Copy link

codecov bot commented Apr 5, 2019

Codecov Report

Merging #270 into master will increase coverage by <.01%.
The diff coverage is 99.41%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #270      +/-   ##
==========================================
+ Coverage   99.31%   99.31%   +<.01%     
==========================================
  Files          52       52              
  Lines        2629     2630       +1     
==========================================
+ Hits         2611     2612       +1     
  Misses         18       18
Impacted Files Coverage Δ
annif/backend/ensemble.py 100% <100%> (ø) ⬆️
tests/test_backend.py 100% <100%> (ø) ⬆️
tests/test_cli.py 100% <100%> (ø) ⬆️
annif/project.py 100% <100%> (ø) ⬆️
annif/suggestion.py 99.02% <100%> (ø)
annif/backend/http.py 100% <100%> (ø) ⬆️
tests/test_project.py 100% <100%> (ø) ⬆️
annif/util.py 97.22% <100%> (ø) ⬆️
tests/test_eval.py 100% <100%> (ø) ⬆️
annif/backend/pav.py 98.52% <100%> (ø) ⬆️
... and 15 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 75c51d0...11c352e. Read the comment docs.

@osma osma merged commit dee89b4 into master Apr 17, 2019
@osma osma deleted the issue267-cli-analyze-to-suggest branch September 30, 2019 12:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename CLI analyze command to suggest
1 participant