NotificationsYou must be signed in to change notification settings
Fork673
Star2.4k

fix: correct ProjectFile.decode() documentation#1405

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

max-wittig merged 1 commit intopython-gitlab:masterfromJohnVillalovos:jlvillal/returns_bytes

Apr 23, 2021

Merged

fix: correct ProjectFile.decode() documentation#1405

max-wittig merged 1 commit intopython-gitlab:masterfromJohnVillalovos:jlvillal/returns_bytes

Apr 23, 2021

Conversation

Copy link

Member

JohnVillalovos commentedApr 23, 2021•
edited
Loading

ProjectFile.decode() returns 'bytes' and not 'str'.

Update the method's doc-string and add a type-hint.

ProjectFile.decode() returns the result of a call to
base64.b64decode()

The docs for that function state it returns 'bytes':
https://docs.python.org/3/library/base64.html#base64.b64decode

Fixes:#1403

JohnVillalovos changed the title~~Correct ProjectFile.decode() documentation~~fix: correct ProjectFile.decode() documentation

Apr 23, 2021

Copy link

codecov-commenter commentedApr 23, 2021

Codecov Report

Merging#1405 (5dc4461) intomaster (711896f) willnot change coverage.
The diff coverage is100.00%.

❗ Current head5dc4461 differs from pull request most recent headaae000d. Consider uploading reports for the commitaae000d to get more accurate results

@@           Coverage Diff           @@##           master    #1405   +/-   ##=======================================  Coverage   80.22%   80.22%           =======================================  Files          73       73             Lines        4071     4071           =======================================  Hits         3266     3266             Misses        805      805

Flag	Coverage Δ
unit	`80.22% <100.00%> (ø)`

Flags with carried forward coverage won't be shown.Click here to find out more.

Impacted Files	Coverage Δ
gitlab/v4/objects/files.py	`50.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend -Click here to learn more
Δ = absolute <relative> (impact),ø = not affected,? = missing data
Powered byCodecov. Last update711896f...aae000d. Read thecomment docs.

fix: correct ProjectFile.decode() documentation

b180baf

ProjectFile.decode() returns 'bytes' and not 'str'.Update the method's doc-string and add a type-hint.ProjectFile.decode() returns the result of a call tobase64.b64decode()The docs for that function state it returns 'bytes':https://docs.python.org/3/library/base64.html#base64.b64decodeFixes:#1403