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

Improve tutorial through "Defining the plugin structure" section #4

Merged
merged 17 commits into from
Dec 2, 2024

Conversation

yeimiyaz
Copy link
Contributor

@yeimiyaz yeimiyaz commented Oct 8, 2024

Pull Request

Pull Request Checklist

  • Read and followed this repo's Contributing Guidelines
  • Based your PR on the latest version of the correct branch
  • Checked your code and writing carefully
  • Described your changes and the motivation for them below

Description of Changes

Modify the first sections of the tutorial.

@yeimiyaz yeimiyaz added the enhancement New feature or request label Oct 8, 2024
@yeimiyaz yeimiyaz self-assigned this Oct 8, 2024
Copy link

netlify bot commented Oct 22, 2024

Deploy Preview for spyder-api-docs-preview ready!

Name Link
🔨 Latest commit 65e744c
🔍 Latest deploy log https://app.netlify.com/sites/spyder-api-docs-preview/deploys/674d4c2954264f00085679c4
😎 Deploy Preview https://deploy-preview-4--spyder-api-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@yeimiyaz yeimiyaz marked this pull request as ready for review October 22, 2024 01:21
@yeimiyaz yeimiyaz changed the title Modify text of tutorial Modify title, description and sections until "Defining the plugin structure" Oct 22, 2024
@CAM-Gerlach CAM-Gerlach changed the title Modify title, description and sections until "Defining the plugin structure" Improve tutorial through "Defining the plugin structure" section Oct 22, 2024
@CAM-Gerlach
Copy link
Member

Hi Yeimi! Jut FYI, after talking with Carlos I pushed commits fixing a variety of formatting and typographical issues with the tutorial, so I could continue reviewing (particularly using one sentence per line, so the substantive review comments and suggestions can be made cleanly), and to avoid bothering either of us with tedious minor fixes so we can focus on the substantive issues at hand. My review is still in progress and is rather late, but you can expect it submitted early tomorrow. Thanks!

@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Oct 23, 2024

Just FYI, I pushed a few additional changes fixing unambiguous textual issues (grammar, punctuation, capitalization, etc.), leaving more non-trivial things like repetition, phrasing, wordiness and content-relevant changes for suggestions in this PR. I also made a commit applying and fixing RST/Sphinx formatting, and one adding ref labels for the sections and topics and linking to them where appropriate.

Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

Thanks Yeimi! Just had some remaining comments

docs/plugin_development.rst Outdated Show resolved Hide resolved
docs/plugin_development.rst Outdated Show resolved Hide resolved
docs/plugin_development.rst Outdated Show resolved Hide resolved
docs/plugin_development.rst Outdated Show resolved Hide resolved
docs/plugin_development.rst Outdated Show resolved Hide resolved
docs/plugin_development.rst Outdated Show resolved Hide resolved
docs/plugin_development.rst Outdated Show resolved Hide resolved
docs/plugin_development.rst Outdated Show resolved Hide resolved
docs/plugin_development.rst Outdated Show resolved Hide resolved
docs/plugin_development.rst Outdated Show resolved Hide resolved
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

Ended up having some more substantive changes than I thought since once I read them carefully, many of the sentences here were confusing or ambiguous.

docs/plugin_development.rst Outdated Show resolved Hide resolved
docs/plugin_development.rst Outdated Show resolved Hide resolved
docs/plugin_development.rst Outdated Show resolved Hide resolved
docs/plugin_development.rst Outdated Show resolved Hide resolved
docs/plugin_development.rst Outdated Show resolved Hide resolved
docs/plugin_development.rst Show resolved Hide resolved
docs/plugin_development.rst Outdated Show resolved Hide resolved
docs/plugin_development.rst Outdated Show resolved Hide resolved
docs/plugin_development.rst Outdated Show resolved Hide resolved
docs/plugin_development.rst Outdated Show resolved Hide resolved
@CAM-Gerlach
Copy link
Member

For some reason, it didn't automatically mark all of the batched suggestions as resolved, even though it did successfully apply them. Never seen that before...

Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

LGTM now, thanks so much for your great work @yeimiyaz !

Copy link
Member

@ccordoba12 ccordoba12 left a comment

Choose a reason for hiding this comment

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

Thanks @yeimiyaz and @CAM-Gerlach for your work on this!

@CAM-Gerlach CAM-Gerlach changed the base branch from master to tutorial-rewrite December 2, 2024 20:49
@CAM-Gerlach CAM-Gerlach merged commit d006202 into spyder-ide:tutorial-rewrite Dec 2, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants