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

docs(classification): correct the casing for full name infotype #10782

Merged
merged 1 commit into from
Jul 1, 2024

Conversation

mayurinehate
Copy link
Collaborator

@mayurinehate mayurinehate commented Jun 26, 2024

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

Summary by CodeRabbit

  • Documentation
    • Updated field name in YAML configuration from Full_name to Full_Name in classification guide.
    • Fixed URL formatting by removing trailing newline at the end of the classification guide.

@github-actions github-actions bot added the ingestion PR or Issue related to the ingestion of metadata label Jun 26, 2024
@hsheth2 hsheth2 added the merge-pending-ci A PR that has passed review and should be merged once CI is green. label Jun 26, 2024
@jjoyce0510 jjoyce0510 enabled auto-merge (squash) June 26, 2024 20:36
auto-merge was automatically disabled July 1, 2024 05:51

Head branch was pushed to by a user without write access

Copy link
Contributor

coderabbitai bot commented Jul 1, 2024

Walkthrough

The recent updates to the classification.md file include renaming the field Full_name to Full_Name within a YAML configuration section, and the removal of a trailing newline from a URL at the end of the file. These changes enhance consistency in field naming and improve the formatting of the documentation.

Changes

File Path Change Summary
metadata-ingestion/docs/dev_guides/classification.md - Renamed Full_name to Full_Name in YAML config section
- Removed trailing newline in URL

Poem

In the docs where configs align,
Full_Name now proudly shines.
A trailing newline bid adieu,
With clarity, our guide renews.
🎉✨ In structured fields, we trust,
For neat docs are a must! 📜🐇


Tip

Early access features: enabled

We are currently testing the following features in early access:

  • OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues.
  • OSS projects are currently opted into early access features by default.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b4e0505 and 3e102b7.

Files selected for processing (1)
  • metadata-ingestion/docs/dev_guides/classification.md (2 hunks)
Additional context used
LanguageTool
metadata-ingestion/docs/dev_guides/classification.md

[uncategorized] ~66-~66: This expression is usually spelled with a hyphen.
Context: ...riving_License_Number-Swift_Code` - Regex based Custom InfoTypes ## Supported sources ...

(BASED_HYPHEN)

Markdownlint
metadata-ingestion/docs/dev_guides/classification.md

455-455: Expected: dash; Actual: asterisk
Unordered list style

(MD004, ul-style)


77-77: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


76-76: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


409-409: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


51-51: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


51-51: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


52-52: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


50-50: Expected: 5; Actual: 1; Too few cells, row will be missing data
Table column count

(MD056, table-column-count)

Additional comments not posted (2)
metadata-ingestion/docs/dev_guides/classification.md (2)

342-342: Correct casing for "Full_Name".

The casing correction for "Full_Name" is accurate and aligns with standard naming conventions.


455-455: Remove trailing newline from URL.

The removal of the trailing newline from the URL is correct and improves the formatting.

Tools
Markdownlint

455-455: Expected: dash; Actual: asterisk
Unordered list style

(MD004, ul-style)

@hsheth2 hsheth2 merged commit b6ec52b into datahub-project:master Jul 1, 2024
50 of 51 checks passed
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ingestion PR or Issue related to the ingestion of metadata merge-pending-ci A PR that has passed review and should be merged once CI is green.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants