Skip to content
This repository has been archived by the owner on Jul 3, 2023. It is now read-only.

fix minor formatting and grammar issues in docs #102

Merged
merged 3 commits into from
Apr 11, 2022
Merged

fix minor formatting and grammar issues in docs #102

merged 3 commits into from
Apr 11, 2022

Conversation

jameslamb
Copy link
Contributor

Fixes some minor formatting and grammar issues I noticed while reading through this project's documentation.

Changes

  • fixes formatting in .md files
  • fixes small grammar issues

Testing

None

Notes

None

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Passes all existing automated tests
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.
  • Reviewers requested with the Reviewers tool ➡️

Testing checklist

Python - local testing

  • python 3.6
  • python 3.7

README.md Show resolved Hide resolved
basics.md Outdated Show resolved Hide resolved
@elijahbenizzy
Copy link
Collaborator

Nice finds! I think the only intentional one is the *modules :)

@jameslamb
Copy link
Contributor Author

I think the only intentional one is the *modules

Ok, sure. Did you mean that you want a literal * at the beginning of that section, or that it was intended to be closed with another * to italicize it?

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
basics.md Outdated Show resolved Hide resolved
@skrawcz
Copy link
Collaborator

skrawcz commented Mar 31, 2022

I think the only intentional one is the *modules

Ok, sure. Did you mean that you want a literal * at the beginning of that section, or that it was intended to be closed with another * to italicize it?

We meant for it to be a literal * to match the parameter declaration.

@skrawcz
Copy link
Collaborator

skrawcz commented Apr 11, 2022

@jameslamb mind if I squash merge? I want to remove the merge commit - else I would do a rebase merge.

@skrawcz skrawcz merged commit b8dc66b into stitchfix:main Apr 11, 2022
@jameslamb
Copy link
Contributor Author

Don't mind at all! I think this project should use exclusively squash merging, so no one ever has to rebase or think about commit messages (as the PR title + a link to it automatically become the commit message).

That has worked very well for us in LightGBM for years.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants