Skip to content

Commit 0705153

Browse files
committed
Emit deprecated tags for legacy parameters
1 parent f89c209 commit 0705153

12 files changed

Lines changed: 54 additions & 30 deletions

codegen/lib/handlebars-helpers.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ export const rubyParamDoc = (
3333
): string => {
3434
const [firstLine = '', ...remainingLines] = parameter.description.split('\n')
3535
const deprecation = parameter.isDeprecated
36-
? `Deprecated: ${parameter.deprecationMessage}`
37-
: ''
38-
const firstLineDescription = [firstLine, deprecation]
39-
.filter((part) => part !== '')
40-
.join(' ')
36+
? [
37+
`@deprecated ${parameter.name}: ${parameter.deprecationMessage}`.trimEnd(),
38+
]
39+
: []
4140
return comment(
4241
[
43-
`@param ${parameter.name} ${firstLineDescription}`.trimEnd(),
42+
`@param ${parameter.name} ${firstLine}`.trimEnd(),
4443
...remainingLines,
44+
...deprecation,
4545
],
4646
indentation,
4747
)

lib/seam/routes/access_codes.rb

Lines changed: 4 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/seam/routes/access_grants.rb

Lines changed: 6 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/seam/routes/acs_entrances.rb

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/seam/routes/acs_users.rb

Lines changed: 4 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/seam/routes/client_sessions.rb

Lines changed: 6 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/seam/routes/devices.rb

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/seam/routes/devices_unmanaged.rb

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/seam/routes/locks.rb

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)