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.

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

Tabulate doc coverage output using markdown #47

Merged
merged 6 commits into from Nov 15, 2022
Merged

Conversation

vvvito
Copy link
Contributor

@vvvito vvvito commented Nov 10, 2022

Resolves #46

What has changed?

Introduces a new argument called cov_format that accepts string (default) or markdown for the compute doc command.

Outputs the results to the terminal in either the default string format, or in a markdown friendly format

Example

dbt-coverage compute doc --cov-format markdown

image

results in:

image

Copy link
Contributor

@mrshu mrshu 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 the PR @vvvito!

It looks rather nice -- I had only one suggestion about the use of Enum -- do let me know if that would make sense to you.

Also, would you mind adding yourself to the CHANGELOG.md just as on the link below? That would help us make sure we attribute your work correctly 🙂

https://github.com/slidoapp/dbt-coverage/pull/38/files#diff-06572a96a58dc510037d5efa622f9bec8519bc1beab13c9f251e97e657a9d4edR9

Thanks!

dbt_coverage/__init__.py Outdated Show resolved Hide resolved
dbt_coverage/__init__.py Outdated Show resolved Hide resolved
dbt_coverage/__init__.py Outdated Show resolved Hide resolved
@vvvito
Copy link
Contributor Author

vvvito commented Nov 15, 2022

Thanks @mrshu
Updated cov_format argument to now accept a CoverageFormat enum object with either 'string' or 'markdown' as potential values - resolving to STRING_TABLE or MARKDOWN_TABLE enum entries.

Also updated Changelog with attribution and resolved conflicts between other PRs

Copy link
Contributor

@mrshu mrshu left a comment

Choose a reason for hiding this comment

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

Thanks a bunch @vvvito, just one last comment and this is good to go!

dbt_coverage/__init__.py Outdated Show resolved Hide resolved
@mrshu mrshu merged commit bb6d574 into slidoapp:main Nov 15, 2022
@mrshu
Copy link
Contributor

mrshu commented Nov 17, 2022

Thanks again @vvvito, this was now released in 0.3.0 (the latest version on PyPI)!

I also took the liberty of adding a short section on it to the docs: https://github.com/slidoapp/dbt-coverage#markdown-output-with---cov-format

I hope you like it!

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.

Format results in markdown table
2 participants