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

Add MLJ compliant doc-strings - take II #23

Merged
merged 7 commits into from
Oct 4, 2022
Merged

Add MLJ compliant doc-strings - take II #23

merged 7 commits into from
Oct 4, 2022

Conversation

ablaom
Copy link
Member

@ablaom ablaom commented Sep 5, 2022

Replaces #22

@pazzo83 I have a reviewed the original PR, to ensure compliance with the new MLJ standard, but have also made some changes of my own (which involve some paring down of your original strings). Would you have time in the next few weeks to do a final review?

I suggest one begins by looking over the final docstrings generated by a julia> ? query, as some of the interpolation magic makes it hard to catch all mistakes by just reading code.

cc @josephsdavid

@ablaom ablaom mentioned this pull request Sep 5, 2022
@codecov-commenter
Copy link

codecov-commenter commented Sep 5, 2022

Codecov Report

Merging #23 (de2281e) into dev (c37e01c) will decrease coverage by 0.27%.
The diff coverage is 91.66%.

@@            Coverage Diff             @@
##              dev      #23      +/-   ##
==========================================
- Coverage   88.04%   87.76%   -0.28%     
==========================================
  Files           7        8       +1     
  Lines         184      188       +4     
==========================================
+ Hits          162      165       +3     
- Misses         22       23       +1     
Impacted Files Coverage Δ
src/MLJText.jl 100.00% <ø> (ø)
src/docstring_helpers.jl 75.00% <75.00%> (ø)
src/bm25_transformer.jl 87.80% <100.00%> (ø)
src/count_transformer.jl 88.00% <100.00%> (ø)
src/tfidf_transformer.jl 87.50% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@pazzo83
Copy link
Collaborator

pazzo83 commented Sep 6, 2022

Yes I will take a look this week! Thanks!

@ablaom
Copy link
Member Author

ablaom commented Sep 22, 2022

@pazzo83 Do you still have some time to look over this?

@pazzo83
Copy link
Collaborator

pazzo83 commented Sep 23, 2022 via email

@pazzo83
Copy link
Collaborator

pazzo83 commented Sep 30, 2022

Again sorry for the delay here! This looks good! Should I merge?

@pazzo83 pazzo83 self-requested a review September 30, 2022 15:41
Copy link
Collaborator

@pazzo83 pazzo83 left a comment

Choose a reason for hiding this comment

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

Looks great! We might need to update some of the package versions in requirements?

@ablaom
Copy link
Member Author

ablaom commented Oct 4, 2022

We might need to update some of the package versions in requirements?

I've kicked CompatHelper out of hibernation and all looks good.

@ablaom ablaom merged commit b42db3f into dev Oct 4, 2022
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