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 docstring to DrfJsonSerializer so we know why it's there #4836

Merged
merged 2 commits into from Nov 1, 2018

Conversation

@ericholscher
Copy link
Member

@ericholscher ericholscher commented Oct 31, 2018

No description provided.

@humitos
Copy link
Member

@humitos humitos commented Oct 31, 2018

Hehe, the linting has failed.

If you run pre-commit it will fix two of the problems:

  • add the final .
  • make it a one line

You will still need to paraphrase it, because "This" is redundant :D

@humitos
Copy link
Member

@humitos humitos commented Oct 31, 2018

It seems that we are "more than strict" with the docstring ;)

@ericholscher
Copy link
Member Author

@ericholscher ericholscher commented Oct 31, 2018

Fixed!

@humitos
Copy link
Member

@humitos humitos commented Oct 31, 2018

Linting will still fail because of the usage of "This" as the first word of the docstring...

@codecov
Copy link

@codecov codecov bot commented Oct 31, 2018

Codecov Report

Merging #4836 into master will decrease coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #4836      +/-   ##
==========================================
- Coverage   76.21%   76.21%   -0.01%     
==========================================
  Files         158      158              
  Lines       10019    10017       -2     
  Branches     1265     1265              
==========================================
- Hits         7636     7634       -2     
  Misses       2039     2039              
  Partials      344      344
Impacted Files Coverage Δ
readthedocs/restapi/client.py 87.09% <100%> (ø) ⬆️
readthedocs/projects/models.py 84% <0%> (-0.07%) ⬇️

@ericholscher ericholscher merged commit fb3c875 into master Nov 1, 2018
3 checks passed
@stsewd stsewd deleted the add-docstring branch Nov 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants