Skip to content

docs: Revamp guides #1550

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

Merged
merged 4 commits into from
Sep 10, 2023
Merged

docs: Revamp guides #1550

merged 4 commits into from
Sep 10, 2023

Conversation

mAxYoLo01
Copy link
Contributor

@mAxYoLo01 mAxYoLo01 commented Aug 29, 2023

The docs generated from this PR can be seen here.

Pull Request Type

  • Feature addition
  • Bugfix
  • Documentation update
  • Code refactor
  • Tests improvement
  • CI/CD pipeline enhancement
  • Other: [Replace with a description]

Description

This PR's goal is to enhance the current guides section of the docs. Some of its key aspects are:

  • Fix typos or incorrect code examples
  • Remove some of the "jokes" that could be present in the guides, especially in the titles of the sections
  • Rewrite some parts of the documentation, add more meaningful examples

Changes

Related Issues

Test Scenarios

Python Compatibility

  • I've ensured my code works on Python 3.10.x
  • I've ensured my code works on Python 3.11.x

Checklist

  • I've run the pre-commit code linter over all edited files
  • I've tested my changes on supported Python versions
  • I've added tests for my code, if applicable
  • I've updated / added documentation, where applicable

@mAxYoLo01 mAxYoLo01 marked this pull request as ready for review September 1, 2023 08:13
@LordOfPolls LordOfPolls merged commit 6592f82 into interactions-py:unstable Sep 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy