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.

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

Add design proposal for better obsoletion #60

Closed
wants to merge 1 commit into from

Conversation

terrajobst
Copy link
Contributor

No description provided.

@terrajobst
Copy link
Contributor Author

Not ready yet.

@terrajobst terrajobst closed this Apr 3, 2019
@terrajobst terrajobst deleted the obsoletion branch April 3, 2019 15:29
@PathogenDavid
Copy link
Contributor

I know you said it's not ready yet, but I read it anyway 😬

I feel like the majority of projects using this would have the same UrlFormat for every Obsolete attribute across the entire project. It'd be nice if the default value for UrlFormat could be applied at the module level. Something like

[module: DefaultObsoleteUrl(UrlFormat="https://aka.ms/obsolete/{0}")]

As an added bonus, this attribute could be injected by the build system. This would allow libraries hosting their documentation out of source control to link to specific versions of the documentation. (IE: Use https://github.com/dotnet/platform-compat/blob/532b760d5e2016ef84696dfd2f0132eb04693651/docs/DE0001.md instead of https://github.com/dotnet/platform-compat/blob/master/docs/DE0001.md)

@terrajobst
Copy link
Contributor Author

If you're insisting, you can comment here: terrajobst#1 😄

@PathogenDavid
Copy link
Contributor

Done! I hope you don't mind I left some other comments that I thought of since that one.

@terrajobst
Copy link
Contributor Author

Not at all! As long as you don't mind me disagreeing 😉

@PathogenDavid
Copy link
Contributor

Disagree away!

@PathogenDavid PathogenDavid mentioned this pull request Apr 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants