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

Add documentation about running DataFed Python package from source repo #1088

Merged
merged 1 commit into from
Nov 14, 2024

Conversation

JoshuaSBrown
Copy link
Collaborator

@JoshuaSBrown JoshuaSBrown commented Nov 14, 2024

Summary by Sourcery

Documentation:

  • Add documentation on how to run the DataFed Python package from the source repository.

@JoshuaSBrown JoshuaSBrown added the Type: Docs - Code Relates to code documentation label Nov 14, 2024
@JoshuaSBrown JoshuaSBrown self-assigned this Nov 14, 2024
Copy link

sourcery-ai bot commented Nov 14, 2024

Reviewer's Guide by Sourcery

This pull request adds documentation to explain how to run the DataFed Python package from the source repository. The changes are straightforward documentation updates with no code modifications.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added documentation for running DataFed Python package from source
  • Added instructions for running the package from source repository
python/datafed_pkg/README

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@JoshuaSBrown JoshuaSBrown linked an issue Nov 14, 2024 that may be closed by this pull request
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @JoshuaSBrown - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The pull request appears to be empty - please include the actual documentation changes you're proposing to add.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@JoshuaSBrown JoshuaSBrown merged commit 6aade47 into devel Nov 14, 2024
11 of 12 checks passed
@JoshuaSBrown JoshuaSBrown deleted the 1087-docs-add-python-dev-run-docs branch November 14, 2024 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Docs - Code Relates to code documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[PythonClient, Docs] - Add documentation for developers
1 participant