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

fix(docs): formatting of transformers code blocks #10670

Merged
merged 1 commit into from
Jun 15, 2024
Merged

fix(docs): formatting of transformers code blocks #10670

merged 1 commit into from
Jun 15, 2024

Conversation

walter9388
Copy link
Contributor

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Overview

Reading the documentation for transformers there was a fair few formatting mistakes in the code blocks.

Some examples

  • Bad Python formatting:
    image
    image

  • Bad YAML formatting:
    image

Might be worth adding some sort of tool for formatting markdown in the CI/CD pipeline (e.g. pre-commit ci)?

@github-actions github-actions bot added ingestion PR or Issue related to the ingestion of metadata community-contribution PR or Issue raised by member(s) of DataHub Community labels Jun 10, 2024
@hsheth2 hsheth2 merged commit edb9cf6 into datahub-project:master Jun 15, 2024
52 checks passed
sleeperdeep pushed a commit to sleeperdeep/datahub that referenced this pull request Jun 25, 2024
@walter9388 @sleeperdeep
fix(docs): formatting of transformers code blocks (datahub-project#10670
7275bb6 
)
yoonhyejin pushed a commit that referenced this pull request Jul 16, 2024
@walter9388 @yoonhyejin
fix(docs): formatting of transformers code blocks (#10670)
2cbe4b4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hsheth2 hsheth2 hsheth2 approved these changes

Assignees
No one assigned
Labels
community-contribution PR or Issue raised by member(s) of DataHub Community ingestion PR or Issue related to the ingestion of metadata
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@walter9388 @hsheth2