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

Request for clarification on methods and attributes references in documentation examples #6

Open
jacklinke opened this issue Nov 21, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@jacklinke
Copy link
Contributor

Is your feature request related to a problem? Please describe.

The section on getting started imports and refers to webinar, but doesn't explain what webinar actually is.

I assume it's something like this?:

@dataclass
class Webinar:
    reminder_time: datetime

    def send_welcome_mail(self):
        pass

    def send_reminder_mail(self):
        pass

    def send_replay_mail(self):
        pass


webinar = Webinar(reminder_time=datetime(2021, 12, 28, 00, 00, 00))

Also, Example issue discussion cycle refers to this.publish_announcement, this.no_new_mails, this.moderation_deadline_reached, this.send_deadline_warning, this.conf_call_this_week, and this.block_calendar, but it's not clear in the example where those methods/attributes come from.

Would these just be additional methods and attributes defined in IssueDiscussion?


  • Can we add some clarification about what these missing imports and methods are, and where the code for them would normally be stored?
  • Maybe fleshing out one of the examples from the documents into a full (but bare-bones) example django project would be helpful?
@jacklinke
Copy link
Contributor Author

BTW, please know that I'm submitting several issues/PRs because I'm excited about your project and want to see it thrive 😃

@fsbraun fsbraun added the documentation Improvements or additions to documentation label Nov 21, 2021
@fsbraun
Copy link
Owner

fsbraun commented Nov 21, 2021

Thanks for the kind words. I appreciate your interest and contributions!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants