Skip to content

findReadMe versitilityΒ #40

@AchillesHeir

Description

@AchillesHeir

Description

The findReadMe functionality isn't super dynamic. In the extension results panel, there is a button that displays the extension's description. It works maybe 80-90 percent of the time, however, sometimes it's grabbing the wrong paragraph or hyperlinks displayed before the description.

Reproduction

https://github.com/oslabs-beta/SusCode/blob/main/src/workers/findReadMe.ts

System information

Not Applicable

Additional information

The overall issue with dynamism is that so many ReadMe formats are different. Different extensions will write there description in different places and label it differently or sometimes do not have a description at all. I think the functionality can be more dynamic than it is now, but making it foolproof is extremely difficult.

πŸ‘¨β€πŸ‘§β€πŸ‘¦ Contributing

  • πŸ™‹β€β™‚οΈ Yes, I'd love to make a PR to fix this bug!

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions