Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Standarization for deprecation message #1348

Open
uilianries opened this issue Jul 3, 2019 · 3 comments
Open

Standarization for deprecation message #1348

uilianries opened this issue Jul 3, 2019 · 3 comments
Labels
complex: low priority: medium stage: queue type: engineering

Comments

@uilianries
Copy link
Member

Hi!

I was working on PR #1347 and can't found a standard format for deprecation notice. What I found:

  • 1 note using warning box (python 2)
  • 1 note using caution box (boost build generator)
  • Many inline comments [DEPRECATED]
  • Conan transit is using (DEPRECATED)

Could we adopt a standard format/box/message when deprecating something?
@danimtb
Copy link
Member

danimtb commented Jul 4, 2019

Normally we use [DEPRECATED] for inlined and maybe just use the caution box for deprecated things

@uilianries
Copy link
Member Author

Yeah, but for what specific cases? Maybe I should use [DEPRECATED] for no_proxy since it's not real important thing like Python 2, right?

@danimtb
Copy link
Member

danimtb commented Jul 4, 2019

It depends if there is a need for an additional message or not. But yeah, for small things, just use [deprecated]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
complex: low priority: medium stage: queue type: engineering
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@uilianries @danimtb