Skip to content

Conversation

@charmasaur
Copy link
Contributor

@charmasaur charmasaur commented Sep 6, 2020

This way they can be properly documented, and will be more type-safe if we ever need different parameters for different functions.

https://q-ctrl.atlassian.net/browse/QENG-1118

For the private function names I've opted to make them consistent with
the scheme names, since those are presumably the most natural ways to
refer to them.

Plan is to make the private functions public, and document those
functions with full details. Eventually we can probably delete the
new_predefined_driven_control, although it's fine to stick around for a
while for compatibility purposes.

https://q-ctrl.atlassian.net/browse/QENG-1118
Largely based on the wiki, although some of the references have been
fixed, and the description of WAMF1 now more accurately matches the
code.

https://q-ctrl.atlassian.net/browse/QENG-1118
charmasaur and others added 9 commits September 6, 2020 16:58
Co-authored-by: Leonardo Andreta de Castro <leonardo.andreta@q-ctrl.com>
Co-authored-by: Leonardo Andreta de Castro <leonardo.andreta@q-ctrl.com>
Co-authored-by: Leonardo Andreta de Castro <leonardo.andreta@q-ctrl.com>
Co-authored-by: Leonardo Andreta de Castro <leonardo.andreta@q-ctrl.com>
@charmasaur charmasaur changed the title Preview of new docs Make individual driven controls functions public Sep 7, 2020
@charmasaur charmasaur marked this pull request as ready for review September 7, 2020 02:40
@charmasaur charmasaur requested review from a team and tachikoma-li September 7, 2020 02:40
@charmasaur charmasaur merged commit cb46e1a into master Sep 7, 2020
@charmasaur charmasaur deleted the QENG-1118 branch September 7, 2020 02:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants