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.

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

Update Makefile #302

Merged
merged 1 commit into from
Dec 10, 2024
Merged

Update Makefile #302

merged 1 commit into from
Dec 10, 2024

Conversation

guilt
Copy link
Contributor

@guilt guilt commented Dec 9, 2024

Issue or Problem Addressed

For a new Developer who is starting with the development, list of commands to learn in make can be exhausting.

Description

  • This PR simplifies the setup of a new developer environment by listing all the targets that Makefile.
  • Adding a new target with inline help ensures that the developer can document this without requiring to add in a separate help section of Makefile.
  • This PR runs formatting and spell check fixes and corrects some scripts.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

This as tested on my Laptop.

List of Tests Added

N/A

Test Procedure

  • make now lists all help targets
Screenshot 2024-12-10 at 2 58 52 PM

Test Configuration

  • Python Version: 3.12.4
  • OS/Distribution: Darwin 23.6.0 Darwin Kernel Version 23.6.0

Review Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have no changes that break existing user workflows. If so, I am providing a deprecation path
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@guilt guilt mentioned this pull request Dec 10, 2024
5 tasks
Copy link
Collaborator

@3coins 3coins left a comment

Choose a reason for hiding this comment

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

@guilt
Thanks for submitting this update, the help improvements look good. Some minor comments to make help messages consistent, looks good otherwise.

libs/aws/Makefile Outdated Show resolved Hide resolved
tests: ## Run all Tests
poetry run pytest $(TEST_FILE)

test: ## Run Individual Test: make test TEST_FILE=test.py
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice! Like the sample commands.

libs/aws/Makefile Outdated Show resolved Hide resolved
libs/aws/Makefile Outdated Show resolved Hide resolved
libs/aws/Makefile Outdated Show resolved Hide resolved
libs/aws/Makefile Outdated Show resolved Hide resolved
libs/aws/Makefile Outdated Show resolved Hide resolved
libs/aws/Makefile Outdated Show resolved Hide resolved
libs/aws/Makefile Outdated Show resolved Hide resolved
libs/aws/Makefile Outdated Show resolved Hide resolved
@guilt guilt force-pushed the guilt-Build-Fixes branch 2 times, most recently from f0bd840 to 7eef101 Compare December 10, 2024 22:49
@guilt guilt force-pushed the guilt-Build-Fixes branch from 7eef101 to 41c214f Compare December 10, 2024 22:51
Copy link
Collaborator

@3coins 3coins left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

@3coins 3coins merged commit e02b396 into langchain-ai:main Dec 10, 2024
12 checks passed
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