Skip to content
This repository has been archived by the owner on Mar 25, 2021. It is now read-only.

Adding documentation example to deprecationRule #3848

Merged
merged 1 commit into from
May 1, 2018
Merged

Adding documentation example to deprecationRule #3848

merged 1 commit into from
May 1, 2018

Conversation

felipeissa
Copy link
Contributor

This adds documentation example to the deprecation rule.

PR checklist

Overview of change:

This adds example to the rule documentation.

CHANGELOG.md entry:

[documentation]

This adds documentation example to the deprecation rule.
@palantirtech
Copy link
Member

Thanks for your interest in palantir/tslint, @felipeissa! Before we can accept your pull request, you need to sign our contributor license agreement - just visit https://cla.palantir.com/ and follow the instructions. Once you sign, I'll automatically update this pull request.

@aervin
Copy link
Contributor

aervin commented Apr 21, 2018

@felipeissa It's possible to add code examples to the rule docs now. Would you consider adding code examples for this rule? Many people may be unaware of what a JSDoc is, and code examples may spark an interest. For an example of the new code example metadata setup, see the curly rule.

@felipeissa
Copy link
Contributor Author

Sure, I can take a look on it. I'll also try to check why this test is failing 😁

@suchanlee
Copy link
Contributor

I just fixed the build here: #3853

@suchanlee suchanlee merged commit 37dddca into palantir:master May 1, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants