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.

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

Jump to bottom

AI summary is based upon code including comments - may be unduly biased by comments #69

Open
RobertASmith opened this issue Apr 29, 2024 · 0 comments
Open

AI summary is based upon code including comments - may be unduly biased by comments #69

RobertASmith opened this issue Apr 29, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@RobertASmith
Copy link
Contributor

Comments included in the code are likely to trump the code itself. There is no guarantee the code does what the comments say.

Options:

  1. Disclaimer - "this has been fed to a LLM with comments and therefore comments may influence description"
  2. Remove comments before passing to LLM.
  3. Pass comments separately and tell LLM that it should say if it believes there is a difference between comments and code.
@RobertASmith RobertASmith added the documentation Improvements or additions to documentation label May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@RobertASmith