Как в библиотеке пометить макрос, как unstable?

Question

[Eugene Usachev]

Пишу собственную библиотеку. Я написал два макроса. Первый использует стабильную версию thread_local, второй - нестабильную.

Когда нестабильную версию стабилизируют, я оставлю только её, переименовав в первый макрос. Однако сейчас я хочу предоставить пользователю выбор. Мне кажется, что стоит предупредить пользователя, что второй макрос будет изменён в дальнейшем (переименован).

Хватит ли пометки в документации? Если нет, как я могу пометить этот макрос?

Answer 1

[Василий Банников]

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

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

Comments

[Eugene Usachev]

Мне нравиться эта мысль, спасибо.