Как задокументировать исправление whatsnew до того, как я отправлю запрос на извлечение панды - PullRequest
1 голос
/ 29 июня 2019

Я исправил небольшую ошибку в Pandas.

Я следовал инструкциям в Правилах вклада панд .Я создал новую среду, собрал исходный код pandas, исправил ошибку и запустил тестовый набор.

Все готово, кроме раздела ' Документирование вашего кода ' Совет:

Изменения должны быть отражены в примечаниях к выпуску, расположенных в doc / source /WhatsNew / vx.yzrst.Этот файл содержит текущий журнал изменений для каждого выпуска.Добавьте запись в этот файл для документирования исправления, улучшения или (неизбежного) критического изменения.Не забудьте указать номер выпуска GitHub при добавлении записи (используйте: Issue: 1234, где 1234 - номер запроса на выпуск / извлечение).

Когда я смотрю на мой каталог \whatsnew,У меня много .rst файлов.Я не уверен, какой из них обновить

Directory of C:\Users\foo\code\pfix\pandas-bar\doc\source\whatsnew

25-Jun-19  10:16 PM    <DIR>          .
25-Jun-19  10:16 PM    <DIR>          ..
25-Jun-19  10:16 PM             2,184 index.rst
25-Jun-19  10:16 PM            16,927 v0.10.0.rst
...<clipped for brevity>...
25-Jun-19  10:16 PM           116,771 v0.24.0.rst
25-Jun-19  10:16 PM             3,976 v0.24.1.rst
25-Jun-19  10:16 PM             5,443 v0.24.2.rst
25-Jun-19  10:16 PM            45,462 v0.25.0.rst
25-Jun-19  10:16 PM             3,421 v0.4.x.rst
...<clipped for brevity>...
25-Jun-19  10:16 PM             3,697 v0.9.0.rst
25-Jun-19  10:16 PM             4,973 v0.9.1.rst
25-Jun-19  10:16 PM            20,421 whatsnew_0171_html_table.html
              50 File(s)      1,093,274 bytes
               2 Dir(s)  738,033,799,168 bytes free

Вывод pd.__version__ моего окружения будет 0.25.0.dev0+791.gf0919f272.dirty Я предполагаю, что мне следует обновить файл v0.25.0.rst, но я не уверен.Кто-нибудь может пожалуйста посоветовать?

1 Ответ

1 голос
/ 29 июня 2019

Если вы разрабатываете для версии vx.y.z, то вы будете регистрировать свои изменения в файле vx.y.z.rst.В вашем случае, 0.25.0.rst .

Ваша версия для панд также отражает это (vx.y.z.dev[...]).

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...