洪民憙 (홍민희) 블로그

기술 문서 작성 도구 Sphinx.. note::.. warning:: 같은 directive들을 제공하고 있는데, 보통은 저 둘의 차이를 잘 이해하지 못한다. 문서에는 .. note::는 API를 사용하는 데 있어서 유의해야 하는 것들을 적는 용도라고 되어 있다. 그럼 .. warning::은 그보다 좀더 중요한 것을 적는 용도일까? 그렇지는 않고, 보안 문제와 관련된 경우에만 .. note:: 대신 쓰길 권장하고 있다.

어차피 API를 쓸 때 유의해야 할 것들은 API 구현자 입장에서는 뭘 적어놓아도 마음이 놓이지 않는 법이다. (대체 C++의 public/private/protected 같은 키워드가 왜 나왔을지 생각해보면.)