hiro/apheleia
1
0
Fork 0
mirror of https://github.com/vale981/apheleia synced 2025-03-04 17:11:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Spelling and grammar fixes (#248)

Browse source
This commit is contained in:
Ville Skyttä 2023-11-23 22:57:05 +02:00 • committed by GitHub
parent 732efe4261
commit 7adc80a310
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
apheleia-formatters.el
View file

@ -314,7 +314,7 @@ strings (matched against value of variable `buffer-file-name'
with `string-match-p'), and the values are symbols with entries with `string-match-p'), and the values are symbols with entries
in `apheleia-formatters' (or equivalently, they are allowed in `apheleia-formatters' (or equivalently, they are allowed
values for `apheleia-formatter'). Values can be a list of such values for `apheleia-formatter'). Values can be a list of such
symnols causing each formatter in the list to be called one after symbols causing each formatter in the list to be called one after
the other (with the output of the previous formatter). the other (with the output of the previous formatter).
Earlier entries in this variable take precedence over later ones. Earlier entries in this variable take precedence over later ones.
@ -459,7 +459,7 @@ NO-QUERY, and CONNECTION-TYPE."
;; capture stderr into a separate buffer, the best we can ;; capture stderr into a separate buffer, the best we can
;; do is save and read from a file. ;; do is save and read from a file.
`(,stdout ,stderr-file) `(,stdout ,stderr-file)
;; Do not re/display stdout as output is recieved. ;; Do not re/display stdout as output is received.
nil) nil)
;; argv[1:] ;; argv[1:]
(cdr command)))) (cdr command))))
@ -801,7 +801,7 @@ This function does not modify DEST in place, it returns a copy."
(defun apheleia--formatter-context (name command remote &optional stdin-buffer) (defun apheleia--formatter-context (name command remote &optional stdin-buffer)
"Construct a formatter context for the formatter with NAME and COMMAND. "Construct a formatter context for the formatter with NAME and COMMAND.
Returns a `apheleia-formatter--context' object on success and nil if Returns an `apheleia-formatter--context' object on success and nil if
the formatter is not executable. The returned formatter context may the formatter is not executable. The returned formatter context may
have some state such as temporary files that the caller is expected have some state such as temporary files that the caller is expected
to cleanup. to cleanup.
@ -995,7 +995,7 @@ being run, for diagnostic purposes."
:scratch scratch :scratch scratch
;; Name of the current formatter symbol, e.g. `black'. ;; Name of the current formatter symbol, e.g. `black'.
:formatter formatter :formatter formatter
;; Callback after succesfully formatting. ;; Callback after successfully formatting.
:callback :callback
(lambda () (lambda ()
(unwind-protect (unwind-protect
@ -1035,7 +1035,7 @@ For more implementation detail, see
FORMATTERS is a list of symbols that appear as keys in FORMATTERS is a list of symbols that appear as keys in
`apheleia-formatters'. BUFFER is the `current-buffer' when this `apheleia-formatters'. BUFFER is the `current-buffer' when this
function was first called. Once all the formatters in COMMANDS function was first called. Once all the formatters in COMMANDS
finish succesfully then invoke CALLBACK with one argument, a finish successfully then invoke CALLBACK with one argument, a
buffer containing the output of all the formatters. REMOTE asserts buffer containing the output of all the formatters. REMOTE asserts
whether the buffer being formatted is on a remote machine or the whether the buffer being formatted is on a remote machine or the
current machine. It should be the output of `file-remote-p' on the current machine. It should be the output of `file-remote-p' on the

2
apheleia-log.el
View file

@ -66,7 +66,7 @@ This points into a log buffer.")
"Log the result of a formatter process. "Log the result of a formatter process.
CTX The formatter process context (see `apheleia-formatter--context'). CTX The formatter process context (see `apheleia-formatter--context').
LOG-BUFFER is the name of the log-buffer. LOG-BUFFER is the name of the log-buffer.
EXIT-OK is true when the formatter exited sucesfully. EXIT-OK is true when the formatter exited successfully.
DIRECTORY is the directory in which the formatter ran. DIRECTORY is the directory in which the formatter ran.
STDERR-STRING is the stderr output of the formatter." STDERR-STRING is the stderr output of the formatter."
(with-current-buffer (get-buffer-create log-buffer) (with-current-buffer (get-buffer-create log-buffer)

2
test/formatters/samplecode/gawk/in.awk
View file

@ -1,6 +1,6 @@
BEGIN { BEGIN {
print "Users and thier corresponding home" print "Users and their corresponding home"
print " UserName \t HomePath" print " UserName \t HomePath"

2
test/formatters/samplecode/gawk/out.awk
View file

@ -1,5 +1,5 @@
BEGIN { BEGIN {
print "Users and thier corresponding home" print "Users and their corresponding home"
print " UserName \t HomePath" print " UserName \t HomePath"
print "___________ \t __________" print "___________ \t __________"
FS = ":" FS = ":"