[docs] remove some out-of-date content in LLVM Programmer's Manual #74989
Conversation
yhgu2000
requested review from
dexonsmith,
nickdesaulniers,
sunfishcode and
kazutakahirata
llvm/docs/ProgrammersManual.rst
Outdated
| .. | ||
| The part about implicit conversion from an iterator to a pointer is out of | ||
| date and has been removed. |
There was a problem hiding this comment.
I added these comments to let someone blame me in the future.
There was a problem hiding this comment.
why not just delete it then?
There was a problem hiding this comment.
why not just delete it then?
When I went through the commit history to confirm the commit that removed operator pointer(), I used GitHub blame to find out who modified the code. I found that commits solely removing content are particularly difficult to locate, as they do not appear in GitHub blame. Therefore, I believe it's best for me to leave a comment here to ensure that someone in the future can blame me in case these revisions cause issues.
Do you think this is a good idea? Let me know your opinion.
There was a problem hiding this comment.
That's considerate, but I agree with @nickdesaulniers that we don't need to be so cautious. Let's just describe the current state accurately. (If we documented all the things we removed we wouldn't have space for the stuff that's still here!)
Remove the part about implicit conversion from an iterator to a pointer. This part of the manual was written 14 years ago, in: llvm@37027c3 There do exist a type casting operator in `ilist` then: https://github.com/llvm/llvm-project/blob/37027c30ec526afe3bb571df6f8701bf0d322f22/llvm/include/llvm/ADT/ilist.h#L192-L194 But it has been remove since 2016: llvm@f197b1f So I think it makes sense to remove this part to avoid mislead new contributors.
|
@dexonsmith @nickdesaulniers Advice taken! |
Remove the part about implicit conversion from an iterator to a pointer.
This part of the manual was written 14 years ago, in: 37027c3
There do exist a type casting operator in
ilistthen:llvm-project/llvm/include/llvm/ADT/ilist.h
Lines 192 to 194 in 37027c3
But it has been remove since 2016: f197b1f
So I think it makes sense to remove this part to avoid mislead new contributors.