Skip to content

Update readme known issues #31

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.

Sign up for GitHub

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
owen-mc merged 2 commits into from
Mar 21, 2025
Merged

Update readme known issues #31

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d13a80
Indent list correctly
owen-mc Mar 21, 2025
ed35197
Add known limitation about promoted methods
owen-mc Mar 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,16 @@ command.

Limitations:

- It is limited to a single package at a time.
- There is no way to automatically stub all exports.
- It does not generate memory-compatible types, as unexported types are
skipped.
- There is no way to automatically detect exports used in a program.
- There is no way to specify specific methods on a type; all methods are
automatically stubbed.
- It cannot currently distinguish between type aliases. This is a
- It is limited to a single package at a time.
- There is no way to automatically stub all exports.
- It does not generate memory-compatible types, as unexported types are
skipped.
- There is no way to automatically detect exports used in a program.
- There is no way to specify specific methods on a type; all methods are
automatically stubbed.
- It cannot currently distinguish between type aliases. This is a
limitation of the `reflect` package.
- It makes new method declarations for promoted methods. This is a
Copy link

Copilot AI Mar 21, 2025

Choose a reason for hiding this comment

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

[nitpick] The sentence about promoted methods is unclear and could be rephrased for better clarity and grammatical correctness. Consider rewording it to, for example, 'Promoted methods generate new declarations, which may lead to unexpected behavior.'

Suggested change
- It makes new method declarations for promoted methods. This is a
- Promoted methods generate new declarations, which may lead to unexpected behavior. This is a

Copilot uses AI. Check for mistakes.
limitation of the `reflect` package.

Please feel free to submit a [pull
Expand Down