Basil L. Contovounesios
b0bef0f407
Don't set text-quoting-style globally
...
* dev/examples-to-docs.el (dash--describe):
* dev/examples-to-info.el (dash--describe): Bind text-quoting-style
here instead of setting it globally.
5 years ago
Basil L. Contovounesios
525ede2d24
Improve docstring Markdown formatting
...
* dev/examples-to-docs.el (dash--describe): Improve docstring.
(quote-and-downcase, unquote-and-link): Remove functions.
(dash--quote-argnames, dash--quote-metavars, dash--quote-hyperlinks)
(dash--indent-blocks): New formatting functions.
(format-docstring): Rename...
(dash--format-docstring): ...to this. All callers changed. Use new
formatting functions on buffer contents for more sophisticated
Markdown formatting.
* README.md: Regenerate.
5 years ago
Basil L. Contovounesios
2aeb4e4f35
Use actual advertised function signature in README
...
* dev/examples-to-docs.el (docs--signature): Remove function.
(dash--describe): New function using the same machinery as
describe-function to determine arglists and docstrings.
(defexamples): Use it instead of docs--signature.
* README.md: Regenerate.
5 years ago
Basil L. Contovounesios
7fc72d9171
Fix Markdown quoting
...
* dev/examples-to-docs.el (format-docstring): Avoid unquoting
already quoted metavariables. Fix token boundaries.
* README.md: Regenerate.
5 years ago
Basil L. Contovounesios
7a9c937877
Translate non-printable chars in docs
...
* dev/examples-to-docs.el (example-to-string):
* dev/examples-to-info.el (example-to-string): Translate chars like
\^A to their printable representations.
* dev/examples.el (-cut): Evaluate quoted lambda in example.
* README.md:
* dash.texi: Regenerate docs.
5 years ago
Basil L. Contovounesios
2625bc526b
Don't use insert-file-contents-literally
...
* dev/examples-to-docs.el (create-docs-file):
* dev/examples-to-info.el (create-info-file): No need to read files
literally.
5 years ago
Basil L. Contovounesios
0f13e5e0bc
Prefer push over add-to-list
...
* dev/examples-to-docs.el (defexamples, def-example-group):
* dev/examples-to-info.el (defexamples, def-example-group): Replace
unneeded add-to-list with push.
5 years ago
Basil L. Contovounesios
609ac28bab
Improve Texinfo markup when documenting errors
...
* dev/examples-to-docs.el (example-to-string): Simplify.
* dev/examples-to-info.el (example-to-string): Use @error{} instead
of @result{} for errors. Use error-message-string to translate
error lists to their corresponding message.
* dev/examples-to-tests.el (example-to-should): Add support for
checking whole error lists, not just error symbols.
* dev/examples.el (-running-sum, -running-product, -iota): Specify
whole error list, not just error symbol.
* dash.texi: Regenerate.
5 years ago
Basil L. Contovounesios
8879c41d30
Use actual dash-functional.el version in README
...
* readme-template.md (Using in a package): Don't hard-code package
version of dash-functional.el.
* dev/examples-to-docs.el (create-docs-file): Substitute package
version of dash-functional.el alongside that of dash.el.
5 years ago
Basil L. Contovounesios
018d30c2ef
Update all library headers for 2021
...
* dash.el:
* dash-functional.el:
* dash-template.texi:
* readme-template.md:
* dev/examples-to-docs.el:
* dev/examples-to-info.el:
* dev/examples-to-tests.el:
* dev/examples.el: Update copyright notice, package version, and
headers. Enable lexical-binding wherever missing.
* README.md:
* dash.texi: Regenerate docs.
5 years ago
Basil L. Contovounesios
1d897cc3ac
Simplify examples-to-docs a bit
...
* dev/examples-to-docs.el (dash-get-package-version): Remove
function.
(create-docs-file): Replace its use with lm-version.
5 years ago
Basil L. Contovounesios
770121b633
Update copyright notices with HTTPS links
...
* LICENSE:
* dash-functional.el:
* dash.el:
* dev/examples-to-docs.el:
* dev/examples-to-info.el:
* dev/examples-to-tests.el:
* dev/examples.el:
* dash-template.texi:
* readme-template.md: Use newest GPL copyright notice text with
HTTPS links.
* README.md:
* dash.texi: Regenerate docs.
5 years ago
Matus Goljer
800c25d1e8
feat(docs): simplify (function x) to #'x
6 years ago
Basil L. Contovounesios
7854ec7141
Fix quote simplification in docs
...
* dev/examples-to-docs.el (simplify-quotes):
* dev/examples-to-info.el (simplify-quotes):
Also replace 'nil with '().
* README.md:
* dash.info:
* dash.texi: Regenerate docs.
7 years ago
Matus Goljer
3b08355b94
Use version from dash.el file when generating readme.
8 years ago
Matus Goljer
406f6f3e71
Fix whitespace
8 years ago
Wilfred Hughes
5d7077a7b4
Set text-quoting-style
...
This enables us to generate docs on newer (25+) Emacsen.
Fixes #192 .
9 years ago
Stefan Monnier
cf70af31f3
Fix check_copyright; Silence compiler-warnings
...
* .gitignore: Add files generated by "make" in elpa.git.
* dash.el (--map-first, --map-last): Silence compile warning when
`rep' does not make use of `it'.
(---partition-all-in-steps-reversed): Remove unused var `len'.
(dash--table-carry): Fix docstring and use DeMorgan.
(-find-indices): Remove unused var `i'.
(-compare-fn): Move before first use.
* dev/examples-to-tests.el:
* dev/examples-to-info.el:
* dev/examples-to-docs.el:
* dev/examples.el: Add copyright boilerplate.
11 years ago
William West
4640a2a51c
Allow for approx comparison of floats in tests
...
defexample entries may now include a symbol `~>' instead of `=>' which
uses an approximate comparison instead of `equal' to compare actual and
expected floating-point values.
Also, for completeness, add support for the `should-error' symbol `!!>' in
`examples-to-docs.el'. This is formatted as the comment ";; Error"
11 years ago
Fredrik Bergroth
0c045f2d3c
Highlight with el instead of cl
11 years ago
Fredrik Bergroth
63fa64f755
Add links to references in readme
11 years ago
Matus Goljer
a09a4b295a
Add code markup for docstrings and fix erroneous whitespace in docstring
12 years ago
Philippe Vaucher
ab727ba4cf
Correct anchors for links starting with '!'
12 years ago
Magnar Sveen
23ab7265d2
Improve formatting of docs
13 years ago
Magnar Sveen
38307e3126
Partition docs
13 years ago
Magnar Sveen
f1049f1607
Add dash-functional back, now dependent on dash.el
...
- instead of the other way around
13 years ago
Wilfred Hughes
b1cfe18231
Fix incorrect alias checking in docs--signature
...
help-split-fundoc expects the function symbol to be the function
name used in the docstring. Since we only use help-split-fundoc for
subrs, this isn't an issue in practice, because subrs use
`(fn some-arg some-other-arg)` rather than an explicit name.
Still, the boolean ought to do what it says it's doing.
13 years ago
Wilfred Hughes
b0ff280894
Updating docs--signature to handle aliases and subrs
...
I've also removed docs--docstring since it's just 'documentation.
13 years ago
Magnar Sveen
1284bc6f96
Move .el files out of root.
...
- to avoid cluttering the provide-namespace
- like not interfering with with ert.el
Fixes #9
13 years ago
Magnar Sveen
5e72ff9c51
Include numbers in github ids.
14 years ago
Magnar Sveen
51ddc1303a
Nice indentation for threading macros.
14 years ago
Magnar Sveen
03370ea899
Simplify examples-to-docs and examples-to-tests with dash
14 years ago
Magnar Sveen
dc6f46cff3
Simplify docs-generation using dash.
14 years ago
Magnar Sveen
eacb6f2884
Docs: Better generation of github urls.
14 years ago
Magnar Sveen
ca3eea7959
Fix examples-to-docs to support documenting macros.
14 years ago
Magnar Sveen
b337ef957b
Sync examples-to-docs.el with the one in s.el
14 years ago
Magnar Sveen
8bd82c7d1c
Show empty lists as '() instead of nil in docs.
14 years ago
Magnar Sveen
286d1d8e97
Show quotes around strings in examples.
14 years ago
Magnar Sveen
2a9e600186
Make functions paragraph into a list of links
14 years ago
Magnar Sveen
1b0d54f1bc
Simplify readme generation.
14 years ago
Magnar Sveen
78fc2a3a5e
Quote and downcase params with digits in them too.
14 years ago
Magnar Sveen
de5ff6af38
Simplify quotes in readme.
14 years ago
Magnar Sveen
4cc4147294
Fix typo
14 years ago
Magnar Sveen
41d77ecd90
Add function list to readme.
14 years ago
Magnar Sveen
722fea6043
Include docs in README
14 years ago
Magnar Sveen
6f0636f61e
Show only three first examples per function.
14 years ago
Magnar Sveen
1997e527e6
Treat dashes in docstring better.
14 years ago
Magnar Sveen
214a7db1ae
Quote and lowercase parameter names in docstring.
14 years ago
Magnar Sveen
85016d32fb
Fix quoted forms like `' in docs.
14 years ago
Magnar Sveen
ec27b47648
Turn tests into examples that can both be tested and turned into docs
14 years ago