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

Remove deprecated non-bordered examples from documentation #180

Merged
merged 1 commit into from
Jan 14, 2025

Conversation

jordanjones243
Copy link
Contributor

@jordanjones243 jordanjones243 commented Jan 9, 2025

Alaska Airlines Pull Request

Before Submitting this pull request:

  • Link all tickets in this repository related to this PR in the Development section
    note: all pull requests require at least one linked ticket
  • If this PR is Ready For Review, all ticket's linked under Development must have their status changed to Ready For Review as well

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license and I have performed a self-review of my own update.

Summary by Sourcery

Remove the borderless input examples from the documentation and update the remaining examples to use the bordered attribute.

Documentation:

  • Remove the borderless input examples from the API documentation.

Tests:

  • Update visual regression tests to reflect the removal of borderless examples.

@jordanjones243 jordanjones243 self-assigned this Jan 9, 2025
@jordanjones243 jordanjones243 requested a review from a team as a code owner January 9, 2025 23:47
Copy link

sourcery-ai bot commented Jan 9, 2025

Reviewer's Guide by Sourcery

This PR removes the deprecated borderless attribute from the auro-input component and updates all examples in the documentation to use the bordered attribute instead.

State diagram showing auro-input attribute changes

stateDiagram-v2
    direction LR
    [*] --> OldState
    OldState --> NewState

    state OldState {
        direction LR
        state "auro-input" as OldInput
        state "Supports both borderless and bordered" as OldBorder
        OldInput --> OldBorder
    }

    state NewState {
        direction LR
        state "auro-input" as NewInput
        state "Only supports bordered" as NewBorder
        NewInput --> NewBorder
    }

    note right of NewState
        Removed deprecated borderless attribute
        All examples updated to use bordered
    end note
Loading

File-Level Changes

Change Details Files
Removed the borderless attribute and related examples.
  • Deleted the borderless attribute from the auro-input component.
  • Removed all instances of the borderless attribute from the documentation and examples.
  • Removed borderless examples from the API documentation.
  • Removed styling for borderless examples from the documentation CSS.
components/input/docs/partials/api.md
components/input/docs/partials/index.md
components/input/apiExamples/borderless.html
components/input/apiExamples/advanced.html
Updated all examples to use the bordered attribute.
  • Added the bordered attribute to all auro-input examples.
  • Simplified the example code by removing redundant non-bordered examples.
components/input/apiExamples/maxLength.html
components/input/apiExamples/minLength.html
components/input/apiExamples/number.html
components/input/apiExamples/pattern.html
components/input/apiExamples/creditCard.html
components/input/apiExamples/creditCardIcon.html
components/input/apiExamples/email.html
components/input/apiExamples/monthDayYear.html
components/input/apiExamples/monthFullYear.html
components/input/apiExamples/monthYear.html
components/input/apiExamples/placeholder.html
components/input/apiExamples/yearMonthDay.html
components/input/apiExamples/activeLabel.html
components/input/apiExamples/noValidate.html
components/input/apiExamples/setCustomValidity.html
components/input/apiExamples/validateOnInput.html
components/input/apiExamples/disabled.html
components/input/apiExamples/error.html
components/input/apiExamples/password.html
components/input/apiExamples/required.html
components/input/README.md
components/input/apiExamples/fullYear.html
components/input/apiExamples/maxDate.html
components/input/apiExamples/maxNumber.html
components/input/apiExamples/minDate.html
components/input/apiExamples/minNumber.html
components/input/apiExamples/month.html
components/input/apiExamples/readonly.html
components/input/apiExamples/value.html
components/input/apiExamples/year.html
components/input/apiExamples/basic.html
components/input/apiExamples/custom.html
components/input/apiExamples/resetState.html
Removed CSS related to borderless styling.
  • Removed CSS styles that were specific to the borderless attribute.
  • Cleaned up and simplified the CSS for the examples.
components/input/docs/partials/api.md
components/input/docs/partials/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

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 @jordanjones243 - 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.

@jordanjones243 jordanjones243 linked an issue Jan 10, 2025 that may be closed by this pull request
rmenner
rmenner previously approved these changes Jan 13, 2025
@jordanjones243 jordanjones243 force-pushed the jjones/removeInputExamples/#177 branch from f5f011e to 2a42011 Compare January 14, 2025 17:34
@jordanjones243 jordanjones243 merged commit d5c7262 into beta Jan 14, 2025
4 checks passed
@jordanjones243 jordanjones243 deleted the jjones/removeInputExamples/#177 branch January 14, 2025 17:36
@jason-capsule42
Copy link
Member

🎉 This PR is included in version 2.0.0-beta.6 🎉

The release is available on:

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.

auro-input Remove doc examples for deprecated layout variations
3 participants