Skip to content

Commit 2eb0fa6

Browse files
committed
Cleanup redondant documentation.
1 parent ca109fb commit 2eb0fa6

1 file changed

Lines changed: 0 additions & 14 deletions

File tree

doc/docs/contributing.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -358,20 +358,6 @@ python3 scripts/faust_doc_api.py --index tests/faust-doc-index.json --pretty get
358358
python3 scripts/faust_doc_api.py --index tests/faust-doc --pretty list_faust_module filters --limit 10
359359
```
360360

361-
Operation semantics mirror `faustforge`:
362-
363-
- `search_faust_lib(query, limit?, module?)`
364-
searches symbols by name, qualified name, summary, and source file without
365-
loading full docs into context
366-
- `get_faust_symbol(symbol)`
367-
returns the full symbol entry plus close alternatives
368-
- `list_faust_module(module, limit?)`
369-
lists symbols from one library module such as `delays` or `filters`
370-
- `get_faust_examples(symbolOrModule, limit?)`
371-
returns the `#### Test` snippets for a symbol or module
372-
- `explain_faust_symbol_for_goal(symbol, goal)`
373-
builds an action-oriented explanation for a concrete DSP objective
374-
375361
The `make clean` target removes the generated JSON artifacts by default:
376362

377363
- `tests/faust-doc-index.json`

0 commit comments

Comments
 (0)