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.

Sign up for GitHub

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

Jump to bottom

Enable linting step in CI for our project preferences, modify the pylint.rc as needed #31

Closed
Tracked by #3
emilyashley opened this issue Dec 6, 2022 · 0 comments · Fixed by #92
Closed
Tracked by #3

Enable linting step in CI for our project preferences, modify the pylint.rc as needed #31

emilyashley opened this issue Dec 6, 2022 · 0 comments · Fixed by #92
Assignees
@emilyashley
Milestone
Beta

Comments

@emilyashley
Copy link
Contributor

emilyashley commented Dec 6, 2022 •
edited

In #5 we set up the steps to run linting, but found it to be too cumbersome at this stage of development.

We should modify pylint to do what we'd like for linting, and ignore any rules we don't really care about.

Once we get to the "Honey add ons" section of the work, we can re-enable and require linting. I imagine this goes hand-in-hand with also setting up types #19 and docstrings.
@emilyashley emilyashley mentioned this issue Dec 6, 2022
Closed
33 tasks
@MikeGoldsmith MikeGoldsmith mentioned this issue Dec 14, 2022
Closed
@JamieDanielson JamieDanielson mentioned this issue Dec 14, 2022
Merged
@vreynolds vreynolds added this to the Beta milestone Feb 1, 2023
This was referenced Feb 25, 2023
Merged
Merged
@emilyashley emilyashley self-assigned this Feb 25, 2023
emilyashley added a commit that referenced this issue Feb 27, 2023
@emilyashley @pkanal
doc: audit of docstrings for dev-friendliness & relevance (#85)
90fbf88 
<!--
Thank you for contributing to the project! 💜
Please see our [OSS process
document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#)
to get an idea of how we operate.
-->

## Which problem is this PR solving?

- Closes #76
- Touches #31 

## Short description of the changes
- adds module docstrings for Distro
- additional class and function docstrings
- more type annotations for return expectations
- additional tests on stdout for local vis exporter

## How to verify that this has the expected result
- reading the docstrings is helpful to you

---------

Co-authored-by: Purvi Kanal <purvikanal@honeycomb.io>
emilyashley added a commit that referenced this issue Feb 27, 2023
@emilyashley
maint: enable linting step in CI (#92)
8a7c626 
<!--
Thank you for contributing to the project! 💜
Please see our [OSS process
document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#)
to get an idea of how we operate.
-->

## Which problem is this PR solving?

- Closes #31 

## Short description of the changes

built off of #85 , please review that one first! Only the last 3 commits
in this PR are finalizing turning on the linting in CI.
## How to verify that this has the expected result

In CircleCI, the linting step should run.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@emilyashley emilyashley

Labels
None yet
Projects
None yet
Milestone
Beta
Development

Successfully merging a pull request may close this issue.

maint: enable linting step in CI honeycombio/honeycomb-opentelemetry-python
2 participants
@vreynolds @emilyashley