[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 2/3] Docstring improvements (via checkdoc)
From: |
Jose E. Marchesi |
Subject: |
Re: [PATCH 2/3] Docstring improvements (via checkdoc) |
Date: |
Wed, 11 Nov 2020 11:15:17 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) |
> (defun rec-update-buffer-descriptors-and-check (&optional
> dont-go-fundamental)
> - "Update buffer descriptors and switch to fundamental mode if
> -there is a parse error."
> + "Update buffer descriptors and check if there's a parse error.
> +
> +Switch to fundamental mode if there is a parse error. If
> +DONT-GO-FUNDAMENTAL is non-nil, don't switch to fundamental."
> (if (rec-buffer-valid-p)
> (progn
> (rec-update-buffer-descriptors)
This new argument dont-go-fundamental doesn't seem to be used...
> (cl-defun rec-query (&rest args
> - &key (type nil) (join nil) (index nil) (sex nil)
> - (fast-string nil) (random nil) (fex nil) (password
> nil)
> - (group-by nil) (sort-by nil) (icase nil) (uniq nil))
> + &key (type nil) (join nil) (index nil) (sex nil)
> + (fast-string nil) (random nil) (fex nil)
> (password nil)
> + (group-by nil) (sort-by nil) (icase nil) (uniq
> nil))
> "Perform a query in the current buffer using recsel.
>
> -ARGS contains the arguments to pass to the program."
> +ARGS contains the arguments to pass to the program.
> +
> +Optional argument TYPE speficies the type of records to select.
> +
> +Optional argument JOIN the field to perform a join operation with.
> +
> +Optional argument INDEX chooses record at specified index.
> +
> +Optional argument SEX is a selection expression to use.
> +
> +Optional argument FAST-STRING is a fast search on the string.
> +
> +Optional argument RANDOM selects a given number of random records.
> +
> +Optional argument FEX prints the specified fields (field expression).
> +Optional argument PASSWORD specifies the password to use.
> +Optional argument GROUP-BY groups results by given fields.
> +Optional argument SORT-BY sorts the output by given fields.
> +Optional argument ICASE makes the selection case-insensitive.
> +Optional argument UNIQ when non-nil, returns only unique results."
Why leaving blank lines between some of the argument descriptions and
not all? (or none? :))
> -(provide 'rec-mode)
> -
> ;; Local variables:
> ;; outline-regexp: ";;;;"
> ;; End:
>
> +(provide 'rec-mode)
> ;;; rec-mode.el ends here
Why oving the provide after the local variables block?
- [PATCH 0/3] Font lock and docstring fixes, Antoine Kalmbach, 2020/11/11
- [PATCH 1/3] Font lock fixes and many small checkdoc fixes, Antoine Kalmbach, 2020/11/11
- [PATCH 2/3] Docstring improvements (via checkdoc), Antoine Kalmbach, 2020/11/11
- Re: [PATCH 2/3] Docstring improvements (via checkdoc),
Jose E. Marchesi <=
- Re: [PATCH 2/3] Docstring improvements (via checkdoc), Antoine Kalmbach, 2020/11/11
- Re: [PATCH 2/3] Docstring improvements (via checkdoc), Jose E. Marchesi, 2020/11/11
- Re: [PATCH 2/3] Docstring improvements (via checkdoc), Antoine Kalmbach, 2020/11/11
- Re: [PATCH 2/3] Docstring improvements (via checkdoc), Jose E. Marchesi, 2020/11/11
- Re: [PATCH 2/3] Docstring improvements (via checkdoc), Antoine Kalmbach, 2020/11/11
[PATCH 3/3] Add Info mode manual, Antoine Kalmbach, 2020/11/11