Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document all exported functions #40

Open
notmgsk opened this issue Jan 28, 2019 · 2 comments
Open

Document all exported functions #40

notmgsk opened this issue Jan 28, 2019 · 2 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed $$ paying off tech debt $$ Paying off tech debt in the codebase.

Comments

@notmgsk
Copy link
Member

notmgsk commented Jan 28, 2019

The undocumented:

(loop for s being each external-symbol of (symbol-package 'cl-quil:**empty-memory-model**) 
      when (and (fboundp s)
                (not (documentation (symbol-function s) t)))
        collect s)
(CL-QUIL:BUILD-8Q-CHIP CL-QUIL:PRAGMA-MATRIX-ENTRIES
                       CL-QUIL:PARSED-PROGRAM-CIRCUIT-DEFINITIONS
                       CL-QUIL:IS-PARAM CL-QUIL:CONSTANT-VALUE
                       CL-QUIL:APPLICATION-OPERATOR
                       CL-QUIL:MEMORY-DESCRIPTOR-NAME
                       CL-QUIL:MEMORY-ALIAS-SIZE-IN-BITS
                       CL-QUIL:MEMORY-REF-NAME CL-QUIL:PRAGMA-QUBIT-ARGUMENTS
                       CL-QUIL:MEMORY-DESCRIPTOR-LENGTH
                       CL-QUIL:PARSED-PROGRAM-GATE-DEFINITIONS
                       CL-QUIL:CONDITIONAL-JUMP-ADDRESS
                       CL-QUIL:PARSED-PROGRAM-MEMORY-DEFINITIONS
                       CL-QUIL:MEMORY-ALIAS-LENGTH CL-QUIL:GATE-NAME
                       CL-QUIL:MEMORY-MODEL-NAMES CL-QUIL:TARGET CL-QUIL:PARAM
                       CL-QUIL:CLASSICAL-TARGET CL-QUIL:PARAM-NAME
                       CL-QUIL:CLASSICAL-LEFT-OPERAND
                       CL-QUIL:CONTROLLED-OPERATOR CL-QUIL:PRAGMA-QUBIT-INDEX
                       CL-QUIL:MEASURE-ADDRESS CL-QUIL:MEMORY-NAME-REGION-NAME
                       CL-QUIL:MREF CL-QUIL:MAKE-PRAGMA CL-QUIL:DAGGER-OPERATOR
                       CL-QUIL:RESET-QUBIT-TARGET CL-QUIL:QUBIT
                       CL-QUIL:JUMP-LABEL CL-QUIL:GATE-DEFINITION-PARAMETERS
                       CL-QUIL:MEMORY-MODEL-SIZEOF
                       CL-QUIL:QUIL-MEMORY-MODEL-ERROR
                       CL-QUIL:SIMPLE-GATE-MATRIX CL-QUIL:MEMORY-ALIAS-TYPE
                       CL-QUIL:IS-MREF CL-QUIL:MEMORY-ALIAS-NAME
                       CL-QUIL:MEMORY-ALIAS-ROOT-MEMORY
                       CL-QUIL:MEMORY-REF-POSITION CL-QUIL:MEMORY-MODEL-ALIASES
                       CL-QUIL:APPLICATION-PARAMETERS
                       CL-QUIL:APPLICATION-ARGUMENTS
                       CL-QUIL:MEMORY-DESCRIPTOR-TYPE
                       CL-QUIL:GATE-DEFINITION-ENTRIES
                       CL-QUIL:CLASSICAL-RIGHT-OPERAND
                       CL-QUIL:PRINT-INSTRUCTION
                       CL-QUIL:PARSED-PROGRAM-EXECUTABLE-CODE
                       CL-QUIL:MEMORY-MODEL-ALIGNMENT CL-QUIL:MEASUREMENT-QUBIT
                       CL-QUIL:NAMED-OPERATOR CL-QUIL:MEMORY-NAME
                       CL-QUIL:PRAGMA-OPERATOR-NAME CL-QUIL:CONSTANT
                       CL-QUIL:GATE-DEFINITION-NAME
                       CL-QUIL:PERMUTATION-GATE-PERMUTATION
                       CL-QUIL:PRAGMA-WORDS CL-QUIL:MEMORY-MODEL-ROOTS
                       CL-QUIL:MEMORY-ALIAS-STARTING-BIT
                       CL-QUIL:PRAGMA-FREEFORM-STRING
                       CL-QUIL:DYNAMIC-GATE-ARITY
                       CL-QUIL:MEMORY-MODEL-REAL-BITS
                       CL-QUIL:MEMORY-MODEL-INTEGER-BITS CL-QUIL:QUBIT-INDEX)
@stylewarning
Copy link
Member

It might even be good to make a unit test of sorts for this kind of thing

@stylewarning
Copy link
Member

See also: #566

@stylewarning stylewarning added $$ paying off tech debt $$ Paying off tech debt in the codebase. enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Jan 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed $$ paying off tech debt $$ Paying off tech debt in the codebase.
Projects
None yet
Development

No branches or pull requests

2 participants