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

Low-level and internal are not mutually exclusive

Browse source
This commit is contained in:
Arthur Maciel 2021-02-02 21:20:53 -03:00
parent fc2ae1243d
commit 5dd744c258
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -373,20 +373,20 @@ Use `:` to explicitly note the namespace from which a name comes. **Only** use w
foo:procedure
### Low-level internal procedures (% or _)
### Low-level and/or internal procedures (% or _)
Use `%` or `_` to prefix low-level procedures that are NOT exposed by an API.
Use `%` or `_` to prefix low-level and/or internal procedures.
%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.
Although not necessary, 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/exposed procedures work as wrappers around the low-level/internal ones.
```Scheme
%retrieve-data ;; low-level and not exposed
retrieve-data ;; high-level and exposed - a wrapper around %retrieve-data
%retrieve-data ;; low-level/internal
retrieve-data ;; high-level/exposed - a wrapper around %retrieve-data
_py-eval ;; deals with C pointers and Python stuff
py-eval ;; deals only with Scheme data types