github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-27 11:43:37 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
14,873 Commits 35 Branches 80 Tags 116 MiB
02553d8fa6
Commit Graph

37 Commits

Author SHA1 Message Date
Fabian Homborg
4118bda21c docs: Go over the FAQ again 
Mention more fish_config CLI, `$()`, do some rewording, ...
 2021-10-29 17:14:53 +02:00
Fabian Homborg
479c11bc80 FAQ: Remove rarely asked questions 2021-10-24 21:18:31 +02:00
ewtoombs
670636885c docs: Made the abort/edit history feature more discoverable. 
First, I changed "the escape key" to :kbd:`Esc`. This makes this information
easier to find when scanning the docs because it stands out and because it is
more consistent with the docs's formatting of keyboard keys.

Additionally, emphasize that escape/page-down can be used to edit
the original search sting.

Finally, I added a link from the FAQ to history-search to make this mechanism
easier to discover.

This was all to address confusion in former zsh and bash users as to how to
edit a search that is in progress, but this will also help new users. See
https://github.com/fish-shell/fish-shell/pull/6686#issuecomment-872960760
 2021-07-03 16:39:32 +02:00
Fabian Homborg
21f5032a55 docs: Don't speak of "initialization files" 
The file is called "config.fish", not "init.fish". We'll call it
"configuration" now.

"Initialization" might be slightly more precise, but in an irritating
way.

Also some wording improvements to the section. In particular we now
mention config.fish *early*, before the whole shebang.
 2021-05-28 20:49:57 +02:00
Fabian Homborg
0991e0b27f docs: Mention cursor in the wrong position for unicode FAQ 
This is now more likely than the staircase thing since
0660ea5be758a25cbfd5703055af122842c10cb0..25595a94c72c8fd1385bfa66b5efecd26839488b.
 2021-05-18 13:18:35 +02:00
Fabian Homborg
d31d7e4880 docs: Add missing newline 2021-04-11 18:44:19 +02:00
Fabian Homborg
4218c1f1a4 faq: Reword ssh question 
This was a bit stuffy

Also let's mention tmux because that's another thing that may cause this.
 2021-03-08 22:28:26 +01:00
Fabian Homborg
2faf814da4 docs: Point away from set -x 
This is a common anti-pattern, we should try to get people to do `set -gx`.
 2021-02-01 18:12:24 +01:00
Fabian Homborg
dd64035d23 docs: Some adjustments 
Rewordings, :ref: links, typos
 2021-01-27 17:39:09 +01:00
Fabian Homborg
4a7ce4f51c docs: More line-length fixes 2021-01-26 16:15:38 +01:00
Johannes Altmanninger
7c7eac1182 fixup! docs: use monospace for inline code snippets more consistently 2020-11-29 05:59:16 +01:00
Fabian Homborg
e5061bcda1 docs: Use string split -n for pkg-config 
It can in some cases give a trailing space, which causes us to return
an empty element.

Fixes #7465.
 2020-11-08 13:40:00 +01:00
Johannes Altmanninger
4081d58577 docs: use monospace for inline code snippets more consistently 2020-10-26 19:25:41 +01:00
Fabian Homborg
6859ca2405 docs: Link to fish-for-bash-users 
Seems fitting as the first question.

[ci skip]
 2020-10-08 17:32:57 +02:00
Fabian Homborg
8008dfda1e Reorder FAQ 
Try to keep related things together - first the variable questions,
then the prompt questions, then more customization, then syntax
incompatibilities, ...

I'm not convinced all of these are actually frequently asked, or that
all frequently asked questions are here, but that's for later.

[ci skip]
 2020-09-22 17:34:42 +02:00
Fabian Homborg
923f6174ab Adjust the FAQ 2020-08-21 20:46:23 +02:00
Charles Gould
14ccac4887 docs: fix broken links in FAQ 2020-07-16 17:10:36 +02:00
blinry
b178f0921e Rephrase confusing display of key binding in documentation 
The binding Alt+., followed by a full stop, wasn't ideal. Rephrase the sentence to avoid that.
 2020-07-14 20:29:14 +02:00
David Adam
5dd7944d0b faq: add SSH/SFTP/SCP interactive guard suggestions 
See #2160, #2405, #3742, #4432 & #4745, among others.
 2020-06-15 21:46:20 +08:00
Fabian Homborg
801ab95fd0 docs: Explain $XDG_CONFIG_HOME 2020-06-05 19:18:09 +02:00
Fabian Homborg
77fc83c293 docs: Reword history substitution 
That prepend-sudo note was a bit awkward. I'm still not super happy
with it, but it should be better.

Also remove the "simple but effective" comment.
 2020-06-05 19:17:19 +02:00
Fabian Homborg
e646285bcb
Let __fish_prepend_sudo use the last commandline if there is no current one (#7079) 
* docs/faq: Mention prepend_sudo

[ci skip]

* __fish_prepend_sudo: Use $history[1] if commandline is empty

Currently, if you press alt+s with an empty commandline, it inserts
"sudo", which seems fairly useless.

Now, it inserts "sudo " followed by the last history entry, which
makes it a replacement for `sudo !!`.

* docs
 2020-06-04 18:25:02 +02:00
Jason
90b9dd3627 Reword sentence 2020-05-28 17:39:37 +02:00
Fabian Homborg
2f7ac8767e Fix wordo 
English! It's a thing!

[ci skip]
 2020-05-27 18:12:56 +02:00
Fabian Homborg
1dfc701ec6 docs: Slight rewording on the unmatched globs faq 
[ci skip]
 2020-05-27 18:11:59 +02:00
Fabian Homborg
ec267a1d54 Document how fish does not pass along unmatched globs 
See #7043.

[ci skip]
 2020-05-27 18:09:53 +02:00
Johannes Altmanninger
1634a3b15c docs: don't quote code snippets 
The added single quotes don't look great in HTML, and it's already clear
that the monospaced text is to be interpreted literally.
 2020-04-13 22:56:22 +02:00
Fabian Homborg
b61913ee74 docs: Add FAQ about unicode issues 
This is an actual Frequently Asked Question.

[ci skip]
 2020-03-21 18:01:17 +01:00
Charles Gould
54da5b82ba docs: Fix spacing on key combinations 2020-03-21 13:20:34 +01:00
Charles Gould
90b46c72c8 docs: Use arrow symbols consistently 2020-03-21 13:20:34 +01:00
Fabian Homborg
ffd930e35b docs: Format keychords as two :kbd: entries 
Looks better in the html - see #6752.

Also this converts the "ctrl-something" instances I could find to
proper markup.

[ci skip]
 2020-03-19 19:43:49 +01:00
Fabian Homborg
06b317c07f Document funced/funcsave harder 
[ci skip]
 2020-03-19 18:02:16 +01:00
Jason Nader
19e43a5df7 docs: remove undefined label 2020-03-04 10:39:55 -08:00
Fabian Homborg
4f4c9aac34 FAQ: Reword history substitution entry 
[ci skip]
 2020-02-21 19:52:42 +01:00
Fabian Homborg
fdfb8f67d9 FAQ: Remove non-frequently asked questions 
I don't think I've ever had anyone ask about our usage of unicode
private use characters.
 2020-02-21 19:48:20 +01:00
Fabian Homborg
415cbb9e0b FAQ: Add question about mode prompt 
This is actually a frequently asked question.
 2020-02-21 19:45:14 +01:00
Aaron Gyes
85a0ca66e0 We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00