Skip to content

chore: rename what to gitlab_resource #2053

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 2 commits into from
Jun 4, 2022
Merged

chore: rename what to gitlab_resource #2053

merged 2 commits into from
Jun 4, 2022

Conversation

JohnVillalovos
Copy link
Member

@JohnVillalovos JohnVillalovos commented Jun 4, 2022

NOTE: This is based on top of PR: #2052

So can merge this and get both commits or merge #2052 first.

Naming a variable what makes it difficult to understand what it is
used for.

Rename it to gitlab_resource as that is what is being stored.

The Gitlab documentation talks about them being resources:
https://docs.gitlab.com/ee/api/api_resources.html

This will improve code readability.

Less confusing to have it be a normal method.
Naming a variable `what` makes it difficult to understand what it is
used for.

Rename it to `gitlab_resource` as that is what is being stored.

The Gitlab documentation talks about them being resources:
https://docs.gitlab.com/ee/api/api_resources.html

This will improve code readability.
@codecov-commenter
Copy link

Codecov Report

Merging #2053 (c86e471) into main (00aec96) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #2053   +/-   ##
=======================================
  Coverage   94.52%   94.52%           
=======================================
  Files          78       78           
  Lines        4972     4972           
=======================================
  Hits         4700     4700           
  Misses        272      272           
Flag Coverage Δ
cli_func_v4 82.54% <100.00%> (ø)
py_func_v4 80.99% <16.66%> (ø)
unit 85.47% <41.66%> (ø)

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

Impacted Files Coverage Δ
gitlab/cli.py 100.00% <100.00%> (ø)
gitlab/v4/cli.py 90.47% <100.00%> (ø)

Copy link
Member

@nejch nejch left a comment

Choose a reason for hiding this comment

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

I guess whaction should also be called resource_action then to match, if it doesn't get too verbose. But we can do that later

@nejch nejch merged commit 8d30b15 into main Jun 4, 2022
@nejch nejch deleted the jlvillal/resource branch June 4, 2022 04:51
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.

3 participants