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