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

add user message to setNumStates* #89

Merged
merged 5 commits into from Aug 20, 2020

Conversation

wrightaprilm
Copy link
Contributor

Pursuant to #86, explain behavior of the setNumStates* methods so users aren't caught off-guard.

Copy link
Contributor

@willpett willpett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a better place for this message is in the documentation for the member method. Unfortunately, help pages for member methods aren't very accessible right now, but that is a separate issue. I think displaying a message every time this method is used might get a bit cluttered.

I made the message a bit more brief, and also corrected a typo. I also hope it's okay that I renamed your method to "getNumStatesVector" since I think that's what you meant?
@willpett
Copy link
Contributor

Ok, until we get the help pages for member methods working, I think the warning is a good idea. I made it a little more brief (also using RBOUT), and I hope it's okay that I renamed your method to getNumStatesVector, since I think that's what you meant?

@wrightaprilm
Copy link
Contributor Author

Can we leave the name as setNumStatesVector() for continuity between the two?

@willpett
Copy link
Contributor

willpett commented Aug 19, 2020

Well, it is a getter function not a setter. It doesn't modify the object. It just returns a new set of objects.

@willpett willpett merged commit e196d1e into revbayes:development Aug 20, 2020
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