Skip to content

Adding links to redis documents in function calls #1719

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

Merged
merged 3 commits into from
Nov 21, 2021

Conversation

Carlosbogo
Copy link
Contributor

@Carlosbogo Carlosbogo commented Nov 16, 2021

Added links to the documentation in the docstrings in redis/commands/core.py

closes #1712

Added links to commands in redis/commands/core.py
@codecov-commenter
Copy link

codecov-commenter commented Nov 16, 2021

Codecov Report

Merging #1719 (e0be7dd) into master (c02d720) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1719   +/-   ##
=======================================
  Coverage   89.03%   89.04%           
=======================================
  Files          53       53           
  Lines       11078    11051   -27     
=======================================
- Hits         9863     9840   -23     
+ Misses       1215     1211    -4     
Impacted Files Coverage Δ
redis/commands/core.py 83.86% <ø> (-0.02%) ⬇️
redis/sentinel.py 86.53% <0.00%> (-0.65%) ⬇️
redis/connection.py 71.11% <0.00%> (-0.36%) ⬇️
redis/client.py 82.08% <0.00%> (-0.18%) ⬇️
tests/conftest.py 92.25% <0.00%> (+0.05%) ⬆️
tests/test_search.py 98.85% <0.00%> (+0.28%) ⬆️
redis/commands/redismodules.py 100.00% <0.00%> (+14.28%) ⬆️

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 c02d720...e0be7dd. Read the comment docs.

@chayim
Copy link
Contributor

chayim commented Nov 17, 2021

@Carlosbogo Awesome! Now - there are flake8 formatting errors, here. To fix anything with lines that are too long simply add a ' # noqa' (without the quotes) to the end of the associated line.

This would ideally be solved by #1644 anyways.

@chayim chayim changed the title Solves #1712 Adding links to redis documents in function calls Nov 17, 2021
Solved flake8 errors
@chayim
Copy link
Contributor

chayim commented Nov 21, 2021

@Carlosbogo We are so close. There are two flake8 errors left:

./redis/commands/core.py:2187:1: W293 blank line contains whitespace
./redis/commands/core.py:2195:1: W293 blank line contains whitespace

If you can eliminate those (and other flakes), I'll pull this into whichever release this lines up with, 4.0.2 or 4.1.0.

If it helps - you can test locally prior to pushing by:

  1. pip install flake8 (I'm assuming you have a virtualenv) or pip install --user flake8
  2. Run flake8 in your terminal

@Carlosbogo
Copy link
Contributor Author

Thank you for the advice, that will definitely help a lot in the future!

@chayim
Copy link
Contributor

chayim commented Nov 21, 2021

Well this is just awesome. Thank you so much @Carlosbogo for making these changes. I'm going to add it into the upcoming (4.0.2) release. So that we can roll this out tomorrow. 👏

@chayim chayim added the maintenance Maintenance (CI, Releases, etc) label Nov 21, 2021
@chayim chayim merged commit 64791a5 into redis:master Nov 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Maintenance (CI, Releases, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Link commands to redis commands
3 participants