Update documentation to clarify instructions are appended by chahn · Pull Request #1709 · huggingface/smolagents (original) (raw)

Skip to content

Navigation Menu

Sign in

Appearance settings

• • AI CODE CREATION
    * GitHub CopilotWrite better code with AI
    * GitHub SparkBuild and deploy intelligent apps
    * GitHub ModelsManage and compare prompts
    * MCP RegistryNewIntegrate external tools
  • DEVELOPER WORKFLOWS
    * ActionsAutomate any workflow
    * CodespacesInstant dev environments
    * IssuesPlan and track work
    * Code ReviewManage code changes
  • APPLICATION SECURITY
    * GitHub Advanced SecurityFind and fix vulnerabilities
    * Code securitySecure your code as you build
    * Secret protectionStop leaks before they start
  • EXPLORE
    * Why GitHub
    * Documentation
    * Blog
    * Changelog
    * Marketplace

View all features

• • BY COMPANY SIZE
    * Enterprises
    * Small and medium teams
    * Startups
    * Nonprofits
  • BY USE CASE
    * App Modernization
    * DevSecOps
    * DevOps
    * CI/CD
    * View all use cases
  • BY INDUSTRY
    * Healthcare
    * Financial services
    * Manufacturing
    * Government
    * View all industries

View all solutions

• • EXPLORE BY TOPIC
    * AI
    * Software Development
    * DevOps
    * Security
    * View all topics
  • EXPLORE BY TYPE
    * Customer stories
    * Events & webinars
    * Ebooks & reports
    * Business insights
    * GitHub Skills
  • SUPPORT & SERVICES
    * Documentation
    * Customer support
    * Community forum
    * Trust center
    * Partners

View all resources

• • COMMUNITY
    * GitHub SponsorsFund open source developers
  • PROGRAMS
    * Security Lab
    * Maintainer Community
    * Accelerator
    * GitHub Stars
    * Archive Program
  • REPOSITORIES
    * Topics
    * Trending
    * Collections
• • ENTERPRISE SOLUTIONS
    * Enterprise platformAI-powered developer platform
  • AVAILABLE ADD-ONS
    * GitHub Advanced SecurityEnterprise-grade security features
    * Copilot for BusinessEnterprise-grade AI features
    * Premium SupportEnterprise-grade 24/7 support
• Pricing

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted

Saved searches

Use saved searches to filter your results more quickly

Sign in

Sign up

Appearance settings

huggingface / smolagents Public

• Notifications You must be signed in to change notification settings

• Fork2.4k

• Star 26.5k

• Code

• Issues 247

• Pull requests 237

• Discussions

• Actions

• Projects

• Security and quality

• Insights

Additional navigation options

Merged

albertvillanova merged 2 commits intohuggingface:mainfrom

chahn:doc-improvements

Sep 18, 2025

ConversationCommits (2)ChecksFiles changed

Merged

Update documentation to clarify instructions are appended#1709

albertvillanova merged 2 commits intohuggingface:mainfrom

chahn:doc-improvements

Conversation

Copy link Copy Markdown

Contributor

chahn commented

Aug 22, 2025

Added a note in docs/source/en/tutorials/building_good_agents.md explaining that the instructions parameter is appended to the system prompt, rather than replacing it.

[Update documentation to clarify that instructions are appended to t…](/huggingface/smolagents/pull/1709/commits/9c0c2eef6570ade7cf2d32338ed5353313957039 "Update documentation to clarify that `instructions` are appended to the system prompt in CodeAgent initialization.")

[9c0c2ee](/huggingface/smolagents/pull/1709/commits/9c0c2eef6570ade7cf2d32338ed5353313957039)

…he system prompt in CodeAgent initialization.

chahn force-pushed the doc-improvements branch fromb2d7a54 to9c0c2ee Compare

August 22, 2025 15:05

[Clarify documentation regarding the instructions argument in agent …](/huggingface/smolagents/pull/1709/commits/f6ff4904e88bbb0cc9ae367350447d6cc8c22ca3 "Clarify documentation regarding the `instructions` argument in agent initialization, specifying that instructions are appended to the system prompt.")

[f6ff490](/huggingface/smolagents/pull/1709/commits/f6ff4904e88bbb0cc9ae367350447d6cc8c22ca3)

…initialization, specifying that instructions are appended to the system prompt.

albertvillanova approved these changes Sep 18, 2025

View reviewed changes

Copy link Copy Markdown

Member

albertvillanova left a comment

Choose a reason for hiding this comment

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

Thanks for the clarification.

chahn reacted with heart emoji

Copy link Copy Markdown

HuggingFaceDocBuilderDev commented

Sep 18, 2025

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Copy link Copy Markdown

Contributor Author

chahn commented

Sep 18, 2025

•

edited

Loading

@albertvillanova many thanks for reviewing!

albertvillanova merged commit 914c718 into huggingface:main

Sep 18, 2025

4 checks passed

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters

[ Show hidden characters]({{ revealButtonHref }})

Sign up for free to join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

albertvillanova albertvillanova approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants