ICRAR / EAGLE

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

Eagle 1267 #774

Closed M-Wicenec closed 12 hours ago

M-Wicenec commented 13 hours ago

Summary by Sourcery

Enhance the tooltip functionality by allowing certain text to be excluded from markdown conversion using '|||', and update relevant HTML components to utilize this new format.

Enhancements:

sourcery-ai[bot] commented 13 hours ago

Reviewer's Guide by Sourcery

This PR modifies the tooltip handling in the repository and repository file components by adding special markdown exclusion markers (|||) around certain tooltip text. It also includes documentation for this markdown exclusion feature in the tooltip binding handler.

Class diagram for updated eagleTooltip binding handler

classDiagram
    class EagleTooltipBindingHandler {
        +eagleTooltip: function
    }
    note for EagleTooltipBindingHandler "Added markdown exclusion feature using ||| markers"

File-Level Changes

Change Details Files
Added markdown exclusion markers to tooltips
  • Added
markers around repository name and branch in tooltip
  • Added
  • markers around file name in tooltip
  • Added comment explaining that text surrounded by
  • will be excluded from markdown conversion static/components/repository.html
    static/components/repository-file.html
    src/bindingHandlers/eagleTooltip.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).