Page MenuHomePhabricator

[SmallVector] Copy new docs into Doxygen comment
ClosedPublic

Authored by scott.linder on Dec 10 2020, 1:58 PM.

Details

Summary

I went to find a reference for the new recommended behavior in the
sources, and ended up had to refer to D92522 to determine where it ended
up (i.e. ProgrammersManual.rst).

At the risk of the two copies diverging, it seemed useful to note the
new recommended use of SmallVector directly at the class declaration,
and also get the benefit of it appearing in a slightly emphasized way in
the rendered Doxygen.

Diff Detail

Event Timeline

scott.linder created this revision.Dec 10 2020, 1:58 PM
scott.linder requested review of this revision.Dec 10 2020, 1:58 PM
Herald added a project: Restricted Project. · View Herald TranscriptDec 10 2020, 1:58 PM

Small proposed addition to try to encourage the migration to the no-explicit-N form, let me know what you think.

lattner accepted this revision.Dec 10 2020, 2:14 PM

nice, thank you!

This revision is now accepted and ready to land.Dec 10 2020, 2:14 PM
This revision was landed with ongoing or failed builds.Dec 10 2020, 2:20 PM
This revision was automatically updated to reflect the committed changes.

Thanks!

You might want to link to the ProgrammersManual directly from here as well.

Thanks!

You might want to link to the ProgrammersManual directly from here as well.

Woops, sorry for not adding you originally! I think I just copied the reviewers verbatim and didn't think about the author...

I added a "see also" link in 32910f780df4f5add290f176459648f2326674f5, let me know if it isn't what you had in mind. Cheers!