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.

Sign up for GitHub

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

Jump to bottom

More docs #105

Merged
11 commits merged into from Jun 3, 2017
Merged

More docs #105

11 commits merged into from Jun 3, 2017

Conversation

Roughsketch
Copy link
Member

@Roughsketch Roughsketch commented May 31, 2017 •
edited

Some more docs and some miscellaneous fixes.

Added docs:

  • Embed
    • fake
  • Emoji
    • delete
    • edit
    • find_guild_id
    • url
  • Game
    • playing
    • streaming

Miscellaneous fix:

  • Updated references to things like Context::send_message in several builder docs.
  • Deprecated Role::edit_role in favor of Role::edit

@ghost ghost mentioned this pull request May 31, 2017
Closed
19 tasks
ghost
ghost suggested changes Jun 3, 2017
View reviewed changes
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR, just a couple changes with the deprecated function

src/model/guild/role.rs Outdated
///
/// [`Role`]: struct.Role.html
/// [Manage Roles]: permissions/constant.MANAGE_ROLES.html
#[deprecated(since="0.2.1", note="Please use `edit` instead.")]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is deprecated, can we replace the function body with just self.edit(f)?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also since this is deprecated, we can just replace these docs and link to the new function saying /// Alias of [`edit`].

@hsiW hsiW added docs Related to documentation. enhancement An improvement to Serenity. labels Jun 3, 2017
@ghost ghost merged commit c00f349 into serenity-rs:master Jun 3, 2017
@ghost
Copy link

ghost commented Jun 3, 2017

Thanks

@Roughsketch Roughsketch deleted the docs branch June 3, 2017 21:54
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
Assignees
No one assigned
Labels
docs Related to documentation. enhancement An improvement to Serenity.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@Roughsketch @hsiW