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

Mention Code Complete as a resource. #10898

Merged
merged 3 commits into from Sep 19, 2020
Merged

Mention Code Complete as a resource. #10898

merged 3 commits into from Sep 19, 2020

Conversation

bangerth
Copy link
Member

@bangerth bangerth commented Sep 9, 2020

No description provided.

@bangerth
Copy link
Member Author

bangerth commented Sep 9, 2020

I'm reading this book for a second time in its entirety with my research group, and I continue to like it a lot. It's worth mentioning.

examples/step-26/step-26.cc Outdated Show resolved Hide resolved
Copy link
Member

@drwells drwells left a comment

Choose a reason for hiding this comment

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

Looks good to me but I have an optional improvement.

@bangerth
Copy link
Member Author

bangerth commented Sep 9, 2020

So done!

Copy link
Member

@drwells drwells left a comment

Choose a reason for hiding this comment

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

I double checked the doxygen output and we need to fix some minor things.

Comment on lines 189 to 191
resource to this end is the book "<a
href="https://en.wikipedia.org/wiki/Code_Complete">Code
Complete</a>" by Steve McConnell @code CodeComplete . It's already
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
resource to this end is the book "<a
href="https://en.wikipedia.org/wiki/Code_Complete">Code
Complete</a>" by Steve McConnell @code CodeComplete . It's already
resource to this end is the book
<a href="https://en.wikipedia.org/wiki/Code_Complete">"Code Complete"</a>
by Steve McConnell @cite CodeComplete. It's already

doxygen just prints the link literally instead of including the HTML when the whole link is quoted for me. We definitely need @cite and not code.

Copy link
Member Author

Choose a reason for hiding this comment

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

Let me do this via markdown. Does this work for you now?

Copy link
Member

Choose a reason for hiding this comment

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

Almost - you forgot to delete @code and add @cite.

@bangerth
Copy link
Member Author

Fixed now!

@drwells drwells merged commit 06d3599 into dealii:master Sep 19, 2020
@bangerth bangerth deleted the cc branch September 21, 2020 03:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants