Fcalva/cyclone
1
0
Fork 0
mirror of https://github.com/justinethier/cyclone.git synced 2025-05-25 13:05:05 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added style for low-level internal procs

Browse source
This commit is contained in:
Arthur Maciel 2021-02-02 20:44:49 -03:00
parent cfd7512b9a
commit fc2ae1243d
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/Scheme-code-conventions.md
View file

@ -373,6 +373,25 @@ Use `:` to explicitly note the namespace from which a name comes. **Only** use w
foo:procedure foo:procedure
### Low-level internal procedures (% or _)
Use `%` or `_` to prefix low-level procedures that are NOT exposed by an API.
%make-raw-structure
%adjust-settings
_py-eval
_curl-get-opts
Although not a necessarily recommended style, it is not rare to see low-level internal procedures and high-level exposed procedures sharing their name, except for the prefix symbol. Sometimes the high-level procedures work as wrappers around the low-level ones.
```Scheme
%retrieve-data ;; low-level and not exposed
retrieve-data ;; high-level and exposed - a wrapper around %retrieve-data
_py-eval ;; deals with C pointers and Python stuff
py-eval ;; deals only with Scheme data types
```
# Comments # Comments
Write comments only where the code is incapable of explaining itself. This is not a recommendation to avoid comments, but rather an incentive to **prefer self-explanatory code over explanatory comments**. Write comments only where the code is incapable of explaining itself. This is not a recommendation to avoid comments, but rather an incentive to **prefer self-explanatory code over explanatory comments**.