bash-it icon indicating copy to clipboard operation
bash-it copied to clipboard

Document theme compatability matrix

Open jpshelley opened this issue 10 years ago • 9 comments

It would be nice if there was a theme that showed which environment you are in, when using python environments. The standard theme works, but I was hoping for something else. EDIT: I've found doubletime to work as well, maybe a list of theme features that are supported would be nice.

jpshelley avatar Jan 05 '15 14:01 jpshelley

Quick search of the themes directory turns up:

  • Doubletime (all variations) <-- this used to be my theme, so it was the first with Python support
  • Hawaii50
  • Iterate
  • Powerline and Powerline Plain <-- my current theme
  • Tylenol

The two Powerline themes both come with support for conda as well.

Regarding the list -- we could definitely use some help around documentation. Want to take a stab at some changes in the README that outline that?

tswicegood avatar Jan 05 '15 18:01 tswicegood

:+1:

A list/matrix of themes with capabilities (SCM status, return status, Python Env, ...) would be great. The Wiki would probably be the best place for this.

nwinkler avatar Jan 06 '15 07:01 nwinkler

+1 for the capability matrix!

edubxb avatar Jan 06 '15 19:01 edubxb

should probably reside in our readthedocs now!

NoahGorny avatar Dec 06 '20 21:12 NoahGorny

@NoahGorny ping

tbhaxor avatar Jan 08 '21 21:01 tbhaxor

This is pending for someone to pick up. Needs to look at the themes and determine which theme supports what. You are welcome to work on it if you want!

NoahGorny avatar Jan 08 '21 21:01 NoahGorny

This is pending for someone to pick up. Needs to look at the themes and determine which theme supports what. You are welcome to work on it if you want!

Since I am a ArchLinux/Manjaro user I can give you the list of themes that are compatible with it. And how to configure the fonts for those which are not. Just let me know where I can update the information

tbhaxor avatar Jan 08 '21 22:01 tbhaxor

I would create a new file under docs called themes-compatibility-matrix.rst, put the info there and reference from themes.rst

NoahGorny avatar Jan 08 '21 22:01 NoahGorny

Since this is an old thread being revived, I'm going to just comment on the more abstract topic of maintaining our current themes...

IMHO themes should be cleaned up last, and in the meantime only touched when end users are complaining or something is broken. This stems from my belief that we probably want to figure out:

  • dependencies
    • if a theme needs a font or command line tool, how do they document this, how do we tell the users?
    • if a theme relies on functions in one of the plugins, how do we guarantee that they are enabled?
  • graceful degrading
    • I don't think we have a mechanism for checking a theme for load failures before continuing or falling back to the standard prompt.
  • configs
    • do we standardize under environment variables or something else?
    • how do we communicate this to the user, at runtime, so bash-it remains discoverable

All that said, it really would be nice to create a documentation standard for all themes, once these questions are answered.

Note: When I say "discoverable", it means the user isn't expected to have read any documentation before using the tool, and the output and response from the tool should guide them to towards the appropriate docs through the natural failure process. Think like shellcheck - you wouldn't read the entire wiki before running it - you look up each issue when it tells you about it.

cornfeedhobo avatar Feb 01 '21 16:02 cornfeedhobo