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

fix: update whitespace & line endings in doc #95

Merged
merged 1 commit into from
Dec 5, 2024
Merged

Conversation

chrisfalaska
Copy link
Contributor

@chrisfalaska chrisfalaska commented Dec 5, 2024

Alaska Airlines Pull Request

Summary

After running npm run build doc file generated modifications based on whitespace & line ending adjustments.

Committing changes to select component auto-generated doc file.

Bug Fixes:

  • Ensure documentation is checked in after the build process to prevent discrepancies between the code and its documentation.

Documentation:

  • Update the documentation for the auro-select component to ensure consistency and accuracy in the demo examples.

Summary by Sourcery

Fix the process to check in documentation after the build to maintain consistency between code and documentation, and update the auro-select component documentation for accuracy.

Bug Fixes:

  • Ensure documentation is checked in after the build process to prevent discrepancies between the code and its documentation.

Documentation:

  • Update the documentation for the auro-select component to ensure consistency and accuracy in the demo examples.

Copy link

sourcery-ai bot commented Dec 5, 2024

Reviewer's Guide by Sourcery

This PR addresses documentation consistency by committing auto-generated documentation changes after running npm run build. The changes primarily involve whitespace and line ending adjustments in the select component's demo documentation file.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Normalize line endings and whitespace in auto-generated documentation
  • Adjust line endings from CRLF to LF
  • Remove extra blank lines between content sections
  • Standardize indentation in code examples
components/select/demo/index.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


chrisfalaska seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@chrisfalaska chrisfalaska linked an issue Dec 5, 2024 that may be closed by this pull request
@chrisfalaska chrisfalaska self-assigned this Dec 5, 2024
@chrisfalaska chrisfalaska marked this pull request as ready for review December 5, 2024 20:18
@chrisfalaska chrisfalaska requested a review from a team as a code owner December 5, 2024 20:18
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @chrisfalaska - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@chrisfalaska chrisfalaska changed the title fix: check in doc after build fix: update whitespace & line endings in doc Dec 5, 2024
@chrisfalaska chrisfalaska merged commit 76f8027 into main Dec 5, 2024
3 of 6 checks passed
@chrisfalaska chrisfalaska deleted the cfriedberg/94 branch December 5, 2024 20:36
@rmenner
Copy link
Contributor

rmenner commented Dec 16, 2024

🎉 This PR is included in version 1.6.0-beta.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Select Demo Doc
4 participants