Skip to content

Commit

Permalink
docs: update quoting mistakes in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sbougerel committed Nov 6, 2023
1 parent bfe9135 commit 0e8793b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To configure a repository to automatically synchronise, turn on
Settings can be made permanent by adding `.dir-locals.el` in repositories you
want to synchronise. Example:

((nil . ((autosync-magit-commit-message . \"My commit message\")
((nil . ((autosync-magit-commit-message . "My commit message")
(autosync-magit-pull-interval . 30)
(mode . autosync-magit))))

Expand Down Expand Up @@ -98,7 +98,7 @@ This variable is buffer-local.

#### `autosync-magit-dirs`

Alist of `(REPO_DIR . MESSAGE)` that should be synchronised.
Alist of (REPO_DIR . MESSAGE) that should be synchronised.

*DEPRECATED*: use `.dir-locals.el` instead. By using
`.dir-locals.el`, you ensure that your private configuration does
Expand All @@ -114,13 +114,13 @@ committing changes.

#### `(autosync-magit-pull REPO_DIR)`

Do `git fetch` then `git merge` from `REPO_DIR`.
Fetch then merge (if needed) from REPO_DIR.
This interactive function is not throttled, it is executed
asynchronously, as soon as it called.

#### `(autosync-magit-push REPO_DIR MESSAGE)`

Do `git add -A`, `git commit -m -a MESSAGE` then `git push` from `REPO_DIR`.
Stage any change, create commit with MESSAGE and push to REPO_DIR.
This interactive function is not debounced, it is executed
asynchronously, as soon as it called.

Expand Down
12 changes: 6 additions & 6 deletions autosync-magit.el
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@
;; personal notes between devices.
;;
;; To configure a repository to automatically synchronise, turn on
;; `autosync-magit-mode` in a buffer, and set the package variables accordingly.
;; Settings can be made permanent by adding `.dir-locals.el` in repositories you
;; `autosync-magit-mode' in a buffer, and set the package variables accordingly.
;; Settings can be made permanent by adding `.dir-locals.el' in repositories you
;; want to synchronise. Example:
;;
;; ((nil . ((autosync-magit-commit-message . "My commit message")
Expand Down Expand Up @@ -138,7 +138,7 @@ This variable is buffer-local."
:group 'autosync-magit)

(defcustom autosync-magit-dirs nil
"Alist of `(REPO_DIR . MESSAGE)` that should be synchronised.
"Alist of (REPO_DIR . MESSAGE) that should be synchronised.
*DEPRECATED*: use `.dir-locals.el' instead. By using
`.dir-locals.el', you ensure that your private configuration does
Expand All @@ -163,7 +163,7 @@ Stores timing about the pull and push operations."
last-pull next-push)

(defvar autosync-magit--sync-alist ()
"Global alist of `(REPO_DIR . OBJ)': sync OBJ for each DIRS.
"Global alist of (REPO_DIR . OBJ): sync OBJ for each DIRS.
Do not modify this variable directly. Visit files or close
related buffers instead.")
Expand All @@ -188,7 +188,7 @@ related buffers instead.")

;;;###autoload
(defun autosync-magit-pull (repo_dir)
"Do `git fetch' then `git merge' from REPO_DIR.
"Fetch then merge (if needed) from REPO_DIR.
This interactive function is not throttled, it is executed
asynchronously, as soon as it called."
Expand All @@ -203,7 +203,7 @@ asynchronously, as soon as it called."

;;;###autoload
(defun autosync-magit-push (repo_dir message)
"Do `git add -A', `git commit -m -a MESSAGE' then `git push' from REPO_DIR.
"Stage any change, create commit with MESSAGE and push to REPO_DIR.
This interactive function is not debounced, it is executed
asynchronously, as soon as it called."
Expand Down

0 comments on commit 0e8793b

Please sign in to comment.