ICRAR / EAGLE

Editor for the Astronomical Graph Language Environment
GNU Lesser General Public License v3.0
0 stars 1 forks source link

Eagle 1316 #749

Closed M-Wicenec closed 4 weeks ago

M-Wicenec commented 4 weeks ago

Summary by Sourcery

Enhance the graph building tutorial by adjusting delay times for smoother transitions and improving the clarity of node port descriptions. Comment out steps related to key attributes to streamline the tutorial flow.

Enhancements:

sourcery-ai[bot] commented 4 weeks ago

Reviewer's Guide by Sourcery

This pull request implements several changes to the graph building tutorial in the Eagle application. The changes include updating the tutorial steps, modifying UI element interactions, and adjusting visual representations of graph components.

Class diagram for updated tutorial steps in graphBuilding.ts

classDiagram
    class TutorialStep {
        +setPreFunction(function)
        +setWaitType(Wait)
        +setDelayAmount(int)
        +setType(Type)
        +setBackPreFunction(function)
        +setConditionFunction(function)
        +setAlternateHighlightTargetFunc(function)
    }
    class SideWindow {
        +setShown(position: string, visible: boolean)
    }
    class Eagle {
        +resetEditor()
    }
    TutorialStep --> SideWindow : uses
    TutorialStep --> Eagle : uses
    note for TutorialStep "Updated methods for tutorial steps"
    note for SideWindow "Newly imported for side window interactions"
    note for Eagle "Used for resetting editor state"

File-Level Changes

Change Details Files
Update tutorial steps and UI interactions
  • Add SideWindow import and use it to show the left side window
  • Modify delay amounts for certain tutorial steps
  • Update selector for the Parameter Table modal
  • Comment out steps related to Key Attributes and Graph Configs
  • Adjust wording in some tutorial step descriptions
src/tutorials/graphBuilding.ts
Modify visual representation of graph components
  • Update description of output ports from orange to blue outline
  • Update description of input ports from green to solid green
src/tutorials/graphBuilding.ts

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](https://app.sourcery.ai) 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 - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).