Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Improve minor aspects of the code #296

Merged
merged 3 commits into from
Oct 13, 2021
Merged

Improve minor aspects of the code #296

merged 3 commits into from
Oct 13, 2021

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Oct 13, 2021

Description

This PR makes small code quality improvements such as

  • moving module docstrings to the top of the file
  • replacing occurrences of 'CC Catalog' with the generic term 'catalog'

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@dhruvkb dhruvkb requested a review from a team as a code owner October 13, 2021 14:36
@dhruvkb dhruvkb requested review from zackkrida and obulat October 13, 2021 14:36
@dhruvkb dhruvkb added ✨ goal: improvement Improvement to an existing user-facing feature 🤖 aspect: dx Concerns developers' experience with the codebase labels Oct 13, 2021
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

Thank you for extracting this work into its own PR. Great!

@dhruvkb
Copy link
Member Author

dhruvkb commented Oct 13, 2021

It was changing a lot of files in the other PR (#295), making it harder to review.

Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Looks good!

@zackkrida
Copy link
Member

LGTM

Copy link
Contributor

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

Nice!

@dhruvkb dhruvkb merged commit ad2f74a into main Oct 13, 2021
@dhruvkb dhruvkb deleted the improv_cq branch October 13, 2021 18:40
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🤖 aspect: dx Concerns developers' experience with the codebase ✨ goal: improvement Improvement to an existing user-facing feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants