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

SCILPY-BOT Version 1 #1016

Closed
wants to merge 66 commits into from
Closed

SCILPY-BOT Version 1 #1016

wants to merge 66 commits into from

Conversation

jinan02
Copy link
Contributor

@jinan02 jinan02 commented Jul 25, 2024

Quick description

Please include a summary of the changes and the related issue(s) or improvement(s).
Please also include relevant motivation and context. List any dependencies that are required for this change if needed.

...

Type of change

Check the relevant options.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Provide data, screenshots, command line to test (if relevant)

...

Checklist

  • My code follows the style guidelines of this project (run autopep8)
  • I added relevant citations to scripts, modules and functions docstrings and descriptions
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I moved all functions from the script file (except the argparser and main) to scilpy modules
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Copy link

codecov bot commented Aug 5, 2024

Codecov Report

Attention: Patch coverage is 72.72727% with 57 lines in your changes missing coverage. Please review.

Project coverage is 56.30%. Comparing base (175eb67) to head (8ef24dc).
Report is 17 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master    #1016       +/-   ##
===========================================
- Coverage   68.61%   56.30%   -12.32%     
===========================================
  Files         426      613      +187     
  Lines       21834    27229     +5395     
  Branches     3267     3399      +132     
===========================================
+ Hits        14981    15330      +349     
- Misses       5578    10606     +5028     
- Partials     1275     1293       +18     
Components Coverage Δ
Scripts 54.21% <80.64%> (-15.72%) ⬇️
Library 59.65% <66.37%> (-7.05%) ⬇️

Copy link
Member

@frheault frheault left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's what I thought, what we discussed last time was not added (did you forget to push?)

The search for SH finds stuff like still, this should be fixed, no?

image

scilpy/utils/scilpy_bot.py Outdated Show resolved Hide resolved
scilpy/utils/scilpy_bot.py Outdated Show resolved Hide resolved
Copy link
Member

@frheault frheault left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job !
The docstring for function is great, but I think you could add a few comments in the functions to help follow why and how you do certain actions. It is sometime hard to follow between the keyword the synonym, the score and the stem, etc.

A few extra comments (imagine us in 2-3 months trying to maintain your code)

scilpy/utils/scilpy_bot.py Outdated Show resolved Hide resolved
data/Vocabulary/Vocabulary.json Outdated Show resolved Hide resolved
data/Vocabulary/Vocabulary.json Outdated Show resolved Hide resolved
data/Vocabulary/Vocabulary.json Outdated Show resolved Hide resolved
scilpy/utils/scilpy_bot.py Outdated Show resolved Hide resolved
scilpy/utils/scilpy_bot.py Show resolved Hide resolved
scripts/scil_search_keywords.py Show resolved Hide resolved
scripts/scil_search_keywords.py Show resolved Hide resolved
scripts/scil_search_keywords.py Outdated Show resolved Hide resolved
@frheault
Copy link
Member

frheault commented Sep 3, 2024

@arnaudbore Could you test and see if you understand the doc/help and find something using it?

@arnaudbore
Copy link
Contributor

Now we want to merge #1033

@arnaudbore arnaudbore closed this Oct 8, 2024
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.

4 participants