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

shlvl docs for default symbol are inconsistent with code #1925

Closed
sersorrel opened this issue Nov 25, 2020 · 2 comments · Fixed by #2911
Closed

shlvl docs for default symbol are inconsistent with code #1925

sersorrel opened this issue Nov 25, 2020 · 2 comments · Fixed by #2911
Assignees
Labels
📚 documentation Issues for improving the documentations 🌱 good first issue Good first issue to get your feet wet.

Comments

@sersorrel
Copy link

the shlvl module defaults to two trailing spaces after the up-down arrow symbol:

symbol: "↕️ ", // extra space for emoji

but in the docs, symbol is listed with only one trailing space:

| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. |

imo the default should be to have only one trailing space, like other modules:

symbol: "🦀 ",

but as long as the docs and code match i'm happy with either.

@andytom andytom added the 🔧 maintenance Maintenance tasks, usually to do with documentation, CI, or project structure. label Nov 26, 2020
@andytom andytom added the 🌱 good first issue Good first issue to get your feet wet. label Dec 5, 2020
@andytom
Copy link
Member

andytom commented Dec 5, 2020

If I remember correctly the reason some modules have two training spaces is to work around some issues with double width emojis, so I believe the docs should be updated.

@kirktrue
Copy link

kirktrue commented Dec 9, 2020

There do seem to be two spaces in the actual markup source for symbol under SHLVL's configuration options. When the README.md is rendered on GitHub, though, it is only rendering a single space.

@mickimnet mickimnet self-assigned this Dec 9, 2020
@andytom andytom added 📚 documentation Issues for improving the documentations and removed 🔧 maintenance Maintenance tasks, usually to do with documentation, CI, or project structure. labels Jan 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation Issues for improving the documentations 🌱 good first issue Good first issue to get your feet wet.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants