-
Notifications
You must be signed in to change notification settings - Fork 52
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
Update EmailForward
fields
#389
Conversation
Update test fixtures accordingly
lib/dnsimple/struct/email_forward.rb
Outdated
@@ -11,15 +11,23 @@ class EmailForward < Base | |||
attr_accessor :domain_id | |||
|
|||
# @return [String] The "local part" of the originating email address. Anything to the left of the @ symbol. | |||
# DEPRECATED: use `alias_email` instead |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We probably should use @deprecated
https://rubydoc.info/gems/yard/file/docs/Tags.md#deprecated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we actually use YARD in this codebase? I couldn't find it in the gemfile...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤔 we may not be linting, or generating docs from it, but I'd say that's the format we are using for all ruby repos... The @param
and @return
are all YARD...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
dnsimple-ruby/dnsimple.gemspec
Line 25 in be5da19
s.add_development_dependency 'yard' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🥇 Looks great pending the YARD convo. Can we keep the end-of-file white space around? 😄
740668a
to
b32f3ea
Compare
See dnsimple/dnsimple-developer#315 for reference
In this PR:
alias_email
anddestination_email
fields toEmailForward
from
andto
fields in `EmailForward