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

docs: documentation for at() and get() methods #2218

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

docs: documentation for at() and get() methods #2218

wants to merge 15 commits into from

Conversation

jemgillam
Copy link
Contributor

@jemgillam jemgillam commented Oct 22, 2024

Description

Needs review!

  • detail on implementing at and get added under the header "Access methods"
  • added missing detail about the methods a ListStep can accept
  • Saw a missing link while reviewing the methods for a Lambda step

Closes graphile/crystal-pre-merge#497

Copy link

changeset-bot bot commented Oct 22, 2024

⚠️ No Changeset found

Latest commit: bc03aec

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Member

@benjie benjie left a comment

Choose a reason for hiding this comment

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

Really good improvements! Here's some suggested edits 🙌

grafast/website/grafast/step-classes.md Outdated Show resolved Hide resolved
grafast/website/grafast/step-classes.md Outdated Show resolved Hide resolved
grafast/website/grafast/step-classes.md Outdated Show resolved Hide resolved
grafast/website/grafast/step-classes.md Outdated Show resolved Hide resolved
grafast/website/grafast/step-classes.md Outdated Show resolved Hide resolved
@jemgillam
Copy link
Contributor Author

I've reorgainsed the sections on the step-classes page as discussed

I've added a blurb to the https://grafast.org/grafast/step-library/standard-steps/ page as it is linked to directly from the step-classes page, I wrote a small summary taken from the step-library category page

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🌱 In Progress
Development

Successfully merging this pull request may close these issues.

Document that "at" and "get" have special meaning on steps
2 participants