branch: elpa/projectile
commit 06c1b222331ad2728f8951c0831d6b3d19338d36
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
Fix typos in the documentation
---
doc/modules/ROOT/pages/configuration.adoc | 10 +++++-----
doc/modules/ROOT/pages/faq.adoc | 2 +-
doc/modules/ROOT/pages/index.adoc | 2 +-
doc/modules/ROOT/pages/installation.adoc | 2 +-
doc/modules/ROOT/pages/projectile_vs_project.adoc | 8 ++++----
doc/modules/ROOT/pages/projects.adoc | 18 +++++++++---------
doc/modules/ROOT/pages/usage.adoc | 8 ++++----
7 files changed, 25 insertions(+), 25 deletions(-)
diff --git a/doc/modules/ROOT/pages/configuration.adoc
b/doc/modules/ROOT/pages/configuration.adoc
index 44a6bd81e6..4e7cac7543 100644
--- a/doc/modules/ROOT/pages/configuration.adoc
+++ b/doc/modules/ROOT/pages/configuration.adoc
@@ -51,7 +51,7 @@ To force the use of alien indexing in all operating systems:
This can speed up Projectile in Windows significantly (especially on
big projects). The disadvantage of this method is that it's not well
supported on Windows systems, as it requires setting up some Unix
-utilities there. If there's problem, you can always use `native`
+utilities there. If there's a problem, you can always use `native`
indexing mode.
=== Alien indexing
@@ -80,13 +80,13 @@ find . -type f -print0
----
TIP: It's a great idea to install https://github.com/sharkdp/fd[fd] which is
much faster than `find`.
- If `fd` is found, projectile will use as a replacement for `find`.
+ If `fd` is found, projectile will use it as a replacement for `find`.
== Sorting
You can choose how Projectile sorts files by customizing
`projectile-sort-order`.
-NOTE: Note that if Alien indexing is set, files are not sorted by Projectile
at all.
+NOTE: If Alien indexing is set, files are not sorted by Projectile at all.
The default is to not sort files:
@@ -175,7 +175,7 @@ You can purge an individual file from the cache with `M-x
projectile-purge-file-
entire directory with `M-x projectile-purge-dir-from-cache`.
NOTE: Prior to Projectile 2.9 the cache for all projects was serialized to the
same file.
-In Projectile 2.9 this was changed and now each project has it's own cache
file relative to
+In Projectile 2.9 this was changed and now each project has its own cache file
relative to
the project's root directory.
When `projectile-mode` is enabled Projectile will auto-update the project
cache when files
@@ -511,7 +511,7 @@ Projectile can be configured to keep a maximum number of
file buffers of a proje
that are opened at one point. The custom variable `projectile-max-buffer-count`
can be set to an integer that will be the buffer count cap. If this limit is
reached, by opening a new file, Projectile will close the least recent buffer
of
-the current project. If the variable is `nil`, the will be no cap on the buffer
+the current project. If the variable is `nil`, there will be no cap on the
buffer
count.
[source,elisp]
diff --git a/doc/modules/ROOT/pages/faq.adoc b/doc/modules/ROOT/pages/faq.adoc
index a19ef1d451..b8794a23b2 100644
--- a/doc/modules/ROOT/pages/faq.adoc
+++ b/doc/modules/ROOT/pages/faq.adoc
@@ -75,7 +75,7 @@ the deletions are staged, which can be confusing. You can
eliminate
the use of fd in this circumstance by setting `projectile-git-use-fd`
to nil.
-== Do you need some help cleanup up all those tickets that have piled up?
+== Do you need some help cleaning up all those tickets that have piled up?
Certainly! In our https://github.com/bbatsov/projectile/issues/[issue
tracker] we've got
diff --git a/doc/modules/ROOT/pages/index.adoc
b/doc/modules/ROOT/pages/index.adoc
index c6b12c9c75..7a33417210 100644
--- a/doc/modules/ROOT/pages/index.adoc
+++ b/doc/modules/ROOT/pages/index.adoc
@@ -79,7 +79,7 @@ I've started working on Projectile in 2011 and I've been
maintaining it ever sin
project with a single user to one of the most popular packages in the realm of
Emacs. It's a fun project,
but it also requires a lot of work.
-You can support my work on Projectile (and all my other Emacs package) via one
of the following platforms:
+You can support my work on Projectile (and all my other Emacs packages) via
one of the following platforms:
* https://github.com/sponsors/bbatsov[GitHub Sponsors]
* https://ko-fi.com/bbatsov[ko-fi]
diff --git a/doc/modules/ROOT/pages/installation.adoc
b/doc/modules/ROOT/pages/installation.adoc
index a35211554f..b5bbbd7ccd 100644
--- a/doc/modules/ROOT/pages/installation.adoc
+++ b/doc/modules/ROOT/pages/installation.adoc
@@ -38,7 +38,7 @@ kbd:[M-x] `package-refresh-contents` kbd:[RET]
Keep in mind that MELPA packages are built automatically from
the `master` branch, meaning bugs might creep in there from time to
-time. Never-the-less, installing from MELPA is a reasonable way of
+time. Nevertheless, installing from MELPA is a reasonable way of
obtaining Projectile, as the `master` branch is normally quite stable
and serious regressions there are usually fixed pretty quickly.
diff --git a/doc/modules/ROOT/pages/projectile_vs_project.adoc
b/doc/modules/ROOT/pages/projectile_vs_project.adoc
index a1daab1d71..108cf6728b 100644
--- a/doc/modules/ROOT/pages/projectile_vs_project.adoc
+++ b/doc/modules/ROOT/pages/projectile_vs_project.adoc
@@ -10,7 +10,7 @@ When `project.el` was originally introduced it's feature-set
was quite spartan,
== TLDR;
-If the functionality in `project.el` is good enough for you than you should
probably use `project.el`.
+If the functionality in `project.el` is good enough for you then you should
probably use `project.el`.
== At a glance
@@ -101,8 +101,8 @@ as Projectile's `alien` strategy. Admittedly, that's
probably the most commonly
=== `.projectile`
-Projectile has it's own project marker/configuration file. It's a remnant of
the early days of the project where a wanted to build a tool that didn't
-rely on the third-party applications and it's significance today is not that
big. (it will be completely ignored unless you're using `native` or `hybrid`
indexing)
+Projectile has its own project marker/configuration file. It's a remnant of
the early days of the project where I wanted to build a tool that didn't
+rely on the third-party applications and its significance today is not that
big. (it will be completely ignored unless you're using `native` or `hybrid`
indexing)
== Projectile's Pros
@@ -124,4 +124,4 @@ rely on the third-party applications and it's significance
today is not that big
** Built-in packages in theory should be maintained better (or at least for
longer), as they have the Emacs team behind them.
** While Projectile has a rich ecosystem of extensions, over a long enough
period of time likely `project.el` will take the lead.
* Due to its larger size, one can argue that Projectile is more complex than
`project.el`
- ** Admittedly I would have done some things differently if were starting
Projectile today, but I don't think Projetile's core complexity is high.
+ ** Admittedly I would have done some things differently if I were starting
Projectile today, but I don't think Projectile's core complexity is high.
diff --git a/doc/modules/ROOT/pages/projects.adoc
b/doc/modules/ROOT/pages/projects.adoc
index 83242c85b1..4a07aca001 100644
--- a/doc/modules/ROOT/pages/projects.adoc
+++ b/doc/modules/ROOT/pages/projects.adoc
@@ -160,7 +160,7 @@ are the configuration files of various build tools. Out of
the box the following
| Java & friends
| `application.yaml`
-| Gradle wrapper script
+| Gradle project file
| Scala
| `build.sbt`
@@ -204,7 +204,7 @@ are the configuration files of various build tools. Out of
the box the following
| Emacs
| `Eask`
-| Emacs cask file
+| Emacs Eask file
| Emacs
| `Eldev`
@@ -433,7 +433,7 @@ You can also pass a symbolic reference to a function into
your project type defi
:test 'my/test-command)
----
-If you would now navigate to a file that has the `*.java` extension under the
`./tests/` directory and hit `C-c c p` you
+If you would now navigate to a file that has the `*.java` extension under the
`./tests/` directory and hit `C-c p c` you
will see `./gradlew build` as the suggestion. If you were to navigate to a
HTML file the compile command will have switched
to `./gradlew compile-templates`.
@@ -449,7 +449,7 @@ Note that your function has to return a string to work
properly.
=== Related file location
The `:test-prefix` and `:test-suffix` will work regardless of file extension
-or directory path should and be enough for simple projects. The
+or directory path and should be enough for simple projects. The
`projectile-other-file-alist` variable can also be set to find other files
based on the extension.
@@ -515,7 +515,7 @@ Notes:
of a function can be fast as it does not iterate over each source file.
. There is a difference in behaviour between no key and `nil` value for the
key. Only when the key does not exist, other project options such as
-`:test_prefix` or `projectile-other-file-alist` mechanism is tried.
+`:test-prefix` or `projectile-other-file-alist` mechanism is tried.
. If the `:test-dir` option is set to a function, this will take precedence
over
any value for `:related-files-fn` set when
`projectile-toggle-between-implementation-and-test` is called.
@@ -656,7 +656,7 @@ purposes, using functions can give more flexibility. As an
example consider
(src-dir (cl-find-if (lambda (d) (f-exists-p (f-join root d)))
src-dir-guesses)))
(projectile-complementary-dir test-file-path "tests?" src-dir)
- (error "Could not locate a impl file for %s!" test-file-path)))
+ (error "Could not locate an impl file for %s!" test-file-path)))
(projectile-update-project-type
'python-pkg
@@ -724,7 +724,7 @@ precedence with respect to project detection. Let's examine
the defaults:
(a.k.a. `default-directory` in Emacs lingo) up the directory tree. It will
return the first match it discovers. The assumption is pretty simple - the
root marker appear only once, at the root folder of a project. If a root
- marker appear in several nested folders (e.g. you've got nested git
projects),
+ marker appears in several nested folders (e.g. you've got nested git
projects),
the bottom-most (closest to the current dir) match has precedence. You can
customize the root markers recognized by this function via
`projectile-project-root-files-bottom-up`
@@ -1006,11 +1006,11 @@ external command or an Emacs Lisp function:
----
In addition caching of commands can be disabled by setting the variable
-`projectile-project-enable-cmd-caching` is to `nil`. This is useful for
+`projectile-project-enable-cmd-caching` to `nil`. This is useful for
preset-based CMake projects.
By default, Projectile will not add consecutive duplicate commands to its
command history. To alter this behaviour you can use
`projectile-cmd-hist-ignoredups`.
- The default value of `t` means consecutive duplicates are ignore, a value
+ The default value of `t` means consecutive duplicates are ignored, a value
of `nil` means nothing is ignored, and a value of `'erase'` means only
the last duplicate is kept in the command history.
diff --git a/doc/modules/ROOT/pages/usage.adoc
b/doc/modules/ROOT/pages/usage.adoc
index e862e00f99..9e9e9a6250 100644
--- a/doc/modules/ROOT/pages/usage.adoc
+++ b/doc/modules/ROOT/pages/usage.adoc
@@ -131,7 +131,7 @@ to perform file search, it's recommended to install
https://github.com/ggreer/the_silver_searcher[ag] (`the_silver_searcher`)
and/or
https://github.com/BurntSushi/ripgrep[rg] (`ripgrep`)
-TIP: You should also install the Emacs packages `ag`, `ripgrep` or `rg` if you
want to make sure of Projectile's commands `projectile-ag` and
`projectile-ripgrep`.
+TIP: You should also install the Emacs packages `ag`, `ripgrep` or `rg` if you
want to make use of Projectile's commands `projectile-ag` and
`projectile-ripgrep`.
== Basic Usage
@@ -143,7 +143,7 @@ You can learn more about Projectile's notion of a project
xref:projects.adoc[her
NOTE: The extent of the support for every VCS differs and Git is the best
supported
one. Projectile supports some advanced features like working with Git
submodules
- and using `git-grep` instead GNU grep.
+ and using `git-grep` instead of GNU grep.
You need to know only a handful of Projectile commands to start benefiting
from it.
@@ -369,7 +369,7 @@ kbd:[s-p C-h]
It is possible to add additional commands to
`projectile-command-map` referenced by the prefix key in
-`projectile-mode-map`. You can add multiple keymap prefix for all
+`projectile-mode-map`. You can add multiple keymap prefixes for all
commands. Here's an example that adds `super-,` as a command prefix:
[source,elisp]
@@ -395,7 +395,7 @@ add to your Emacs config:
(define-key projectile-mode-map [?\s-g] 'projectile-grep)
----
-NOTE: Note that the `Super` keybindings are not usable in Windows, as Windows
+NOTE: The `Super` keybindings are not usable in Windows, as Windows
makes heavy use of such keybindings itself. Emacs Prelude already adds those
extra keybindings.
