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

@see AdEnvSegment from AdEnv #193

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

keatonuw
Copy link

As a user of DaisySP, it was unclear what integers were valid inputs and outputs from AdEnv::SetTime and AdEnv::GetCurrentSegment.

I've added @see AdEnvSegment comments to AdEnv documentation. This should help future developers quickly find the enumeration through the documentation.

FYI: This is my first PR on GitHub & first contribution to DaisySP! I've read the contribution guides, but let me know if I'm missing anything. Thanks!

@beserge
Copy link
Contributor

beserge commented Dec 11, 2023

Nice catch! My preference is actually to change it so that
AdEnvSegment would be a member of AdEnv, and then the seg argument would be of type AdEnvSegment
i.e. SetTime(AdEnvSegment seg, float time)

I would think that would also fix the documentation issue automatically, though I will check that to make sure.
I'm going to make that change and close this PR soon (we're saving any breaking changes for a little while).

Thanks again for the catch!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants