From 31dc1f9a8c2e6db247779373baefb6acc29b47b4 Mon Sep 17 00:00:00 2001 From: ridiculousfish Date: Sun, 24 Feb 2019 19:41:51 -0800 Subject: [PATCH] Correct the builtin.cpp comment about how to add a new builtin Teach it about Sphinx --- src/builtin.cpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/builtin.cpp b/src/builtin.cpp index f74d5fa74..cb6687e3d 100644 --- a/src/builtin.cpp +++ b/src/builtin.cpp @@ -11,10 +11,10 @@ // 2). Add a line like { L"NAME", &builtin_NAME, N_(L"Bla bla bla") }, to the builtin_data_t // variable. The description is used by the completion system. Note that this array is sorted. // -// 3). Create a file doc_src/NAME.txt, containing the manual for the builtin in Doxygen-format. -// Check the other builtin manuals for proper syntax. +// 3). Create a file sphinx_doc_src/NAME.rst, containing the manual for the builtin in +// reStructuredText-format. Check the other builtin manuals for proper syntax. // -// 4). Use 'git add doc_src/NAME.txt' to start tracking changes to the documentation file. +// 4). Use 'git add sphinx_doc_src/NAME.txt' to start tracking changes to the documentation file. #include "config.h" // IWYU pragma: keep #include