[settings-view] Don’t display heading anchor icons within a README

savetheclocktower commented 9 months ago

Identify the Bug

In the settings-view page for a package, when we convert a README.md to HTML, we are generating GitHub-style heading links, along with icons. We should not be doing this.

Here's why:

Clicking on the anchor doesn't do anything in Pulsar.
Typically these icons are displayed just to make it clear that a heading is linkable, and the user can right-click on the link and select “Copy Link URL” or something like that… but you can't do that in Pulsar, either. The context menu only offers you the commands for splitting the pane in each of four directions.

Hence they do nothing but clutter up the view.

Description of the Change

A one-liner!

Alternate Designs

Instead of doing this, I was almost lazy enough not to do this, which I suppose is a different kind of design decision.

Possible Drawbacks

None. This change improves the world.

Verification Process

An easy one: just look at the one-line change, trust that it does what I say it does, and click on an “Approve” button.

Release Notes

Refrain from rendering anchor icons when showing a package's README file in settings-view.

Daeraxa commented 9 months ago

Yeah, this makes a lot of sense, it isn't like we can copy a meaningful link from a package readme. It could be argued that instead the heading link could copy the URL as if it was on the PPR but honestly I would find that a very difficult sell...

DeeDeeG commented 9 months ago

Counterpoint: I like mousing over the headings as a sort of virtual fidget toy.

XKCD while I'm at it. https://xkcd.com/1172/

But anyway, this is fine.

[EDIT: Oh no, I just looked at a build from before this landed... They don't even dynamically show/hide during mouseover/mouseaway like they do on github.com... Useless as a fidget toy!]

Note: Disregard this comment, I'm just being silly.

pulsar-edit / pulsar