Skip to content

Add docstring to DrfJsonSerializer so we know why it's there - #4836

Merged
ericholscher merged 2 commits into
masterfrom
add-docstring
Nov 1, 2018
Merged

ericholscher merged 2 commits into
masterfrom
add-docstring

Conversation

@ericholscher

Copy link
Copy Markdown
Member

No description provided.

@humitos

humitos commented Oct 31, 2018

Copy link
Copy Markdown
Member

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

humitos commented Oct 31, 2018

Copy link
Copy Markdown
Member

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

@ericholscher

Copy link
Copy Markdown
Member Author

Fixed!

@humitos

humitos commented Oct 31, 2018

Copy link
Copy Markdown
Member

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

@codecov

codecov Bot commented Oct 31, 2018 •

Copy link
Copy Markdown

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
@stsewd
stsewd deleted the add-docstring branch November 1, 2018 15:58
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.

2 participants