이하의 글은 2012년에 쓴 것입니다. 오래된 글인 만큼, 현재의 생각과 전혀 다른 내용도 많이 포함되어 있고, 당시와는 상황이 많이 달라진 점도 있습니다. 또한, 그 당시에 잘못 알려졌던 정보도 포함되어 있을 수 있습니다. 어찌됐든 저는 제 오래된 글이 회자되는 것을 저어합니다. 읽기에 앞서 양해를 부탁드립니다.
기술 문서 작성 도구 Sphinx는 .. note::나 .. warning:: 같은 directive들을 제공하고 있는데, 보통은 저 둘의 차이를 잘 이해하지 못한다. 문서에는 .. note::는 API를 사용하는 데 있어서 유의해야 하는 것들을 적는 용도라고 되어 있다. 그럼 .. warning::은 그보다 좀더 중요한 것을 적는 용도일까? 그렇지는 않고, 보안 문제와 관련된 경우에만 .. note:: 대신 쓰길 권장하고 있다.
어차피 API를 쓸 때 유의해야 할 것들은 API 구현자 입장에서는 뭘 적어놓아도 마음이 놓이지 않는 법이다. (대체 C++의 public/private/protected 같은 키워드가 왜 나왔을지 생각해보면.)