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

Explain how a statement works. #778

Merged
merged 1 commit into from Mar 3, 2016
Merged

Conversation

bangerth
Copy link
Contributor

@bangerth bangerth commented Mar 2, 2016

I realized that this is not obvious after talking to Alberto Sartori.

@tjhei
Copy link
Member

tjhei commented Mar 2, 2016

I find it a bit weird to explain how dynamic_cast and declaring variables inside an if scope work somewhere in the middle of some function, but I guess it doesn't hurt. :-)

Can you capitalize the beginning of sentences?

@bangerth
Copy link
Contributor Author

bangerth commented Mar 2, 2016

It's not quite in the middle of a function but right in front of the block of places where we use this (not visible from the diff by itself). I thought that's probably the place to talk about it.

Re capitalization -- none of the other comments in the function do it. I don't think we're particularly consistent globally (though locally we are, using the style I used here). You tell me how you want it.

tjhei added a commit that referenced this pull request Mar 3, 2016
Explain how a statement works.
@tjhei tjhei merged commit 3432168 into geodynamics:master Mar 3, 2016
@bangerth bangerth deleted the add-doc-text-2 branch March 3, 2016 21:17
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