Как я могу отметить макрос как нестабильный (unstable) в библиотеке?

Как я могу предоставить пользователю выбор между двумя макросами, один из которых будет переименован в будущем? Нужно ли только указать это в документации, или есть другие способы пометить макрос?
  • 9 августа 2024 г. 12:13
Ответы на вопрос 2
Для того чтобы отметить макрос как нестабильный (unstable) в библиотеке, вы можете использовать следующие способы:

1. Включите явное предупреждение в документацию о том, что макрос считается нестабильным и может быть изменен или удален в будущих версиях библиотеки.

2. Добавьте префикс "UNSTABLE_" или другой идентификатор к имени макроса, чтобы пользователи могли легко определить его нестабильный статус.

3. Создайте отдельный раздел в документации, посвященный нестабильным макросам, в котором будет указано их текущее состояние и возможные изменения в будущем.

Чтобы предоставить пользователям выбор между двумя макросами, один из которых будет переименован в будущем, вы можете использовать следующие подходы:

1. Создайте альтернативный макрос с новым именем и предупредите пользователей, что старый макрос будет удален в будущих версиях.

2. Добавьте флаг или параметр к вызову макроса, который позволит пользователю выбрать один из двух вариантов.

3. Опишите в документации, какие макросы будут заменены в будущем и почему, чтобы пользователи могли сделать информированный выбор.

В целом, наилучшим способом пометить макрос в качестве нестабильного или предложить выбор между макросами является понятное и подробное описание в документации, чтобы пользователи могли легко понять текущую ситуацию и принять необходимые меры.
Мне кажется, прямо в названии отражать, что он unstable не обязательно, ибо стабилизация существует только в рамках стандартной библиотеки - просто дай ему другое название и закрой за feature, которую можно включить только на nightly. 

Когда фичу стабилизируют - добавишь в новой версии deprecated с указанием на старый макрос, а потом, в следующей мажорной версии, удалишь окончательно.
Похожие вопросы