Skip to content

docs: Update docs#154

Merged
mkopcins merged 3 commits intosoftware-mansion:mainfrom
pweglik:main
Apr 1, 2025
Merged

docs: Update docs#154
mkopcins merged 3 commits intosoftware-mansion:mainfrom
pweglik:main

Conversation

@pweglik
Copy link
Copy Markdown
Contributor

@pweglik pweglik commented Mar 25, 2025

Description

  • Changed a word from "two examples" to "few examples", so it makes sense. Few is better than three, so it's foolproof longer.

  • Changed method name in useLLM docs, I think runInference is an old name for generate and you forgot to change it.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (improves or adds clarity to existing documentation)

@pweglik pweglik changed the title docs: Update a word in README.md docs: Update docs Mar 25, 2025
Comment thread README.md Outdated
@msluszniak msluszniak requested a review from mkopcins March 26, 2025 11:22
@mkopcins mkopcins merged commit c680266 into software-mansion:main Apr 1, 2025
2 checks passed
mkopcins pushed a commit that referenced this pull request Oct 15, 2025
## Description

- Changed a word from "two examples" to "few examples", so it makes
sense. Few is better than three, so it's foolproof longer.

- Changed method name in `useLLM` docs, I think `runInference` is an old
name for `generate` and you forgot to change it.

### Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [x] Documentation update (improves or adds clarity to existing
documentation)
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.

2 participants