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

Improve internal documentation of skills system #1585

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

Improve internal documentation of skills system #1585

wants to merge 2 commits into from

Conversation

endolith
Copy link

@endolith endolith commented Jan 28, 2025 •
edited
Loading

Describe the changes you have made:

  • Add docstrings for skills functions.
  • If skills are disabled, don't list skills, return an empty list and a message explaining the situation.

Reference any relevant issues (e.g. "Fixes #000"):

When OI tries to list skills, it shows them, but then it can't actually
call them and it gets very confused.

OI tries to call help(computer.skills.import_skills) or
help(computer.skills.list), for instance and there is no documentation.

Pre-Submission Checklist (optional but appreciated):

  • I have included relevant documentation updates (stored in /docs)
  • I have read docs/CONTRIBUTING.md
  • I have read docs/ROADMAP.md

OS Tests (optional but appreciated):

  • Tested on Windows
  • Tested on MacOS
  • Tested on Linux

@endolith
Add docstrings to explain skills system to OI
75ef14d 
OI tries to call help(computer.skills.import_skills) or
help(computer.skills.list), for instance and there is no documentation.
@endolith
Clarify skills messages in list() and search()
119198c 
Update error messages to better explain how to enable skills, and return
empty list if skills are disabled.

When OI tries to list skills, it shows them, but then it can't actually
call them and it gets very confused.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@endolith