Skip to content

fix structure #34

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

Merged
vishalshenoy merged 1 commit into from
Jan 29, 2025
Merged

fix structure #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions STRUCTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ This guide explains how to structure examples for the Codegen library. A well-st
example-name/
├── README.md # Documentation and usage examples
├── run.py # Main implementation
├── guide.md # (Optional) Additional technical details
└── input_repo/ # (Optional) Sample code for transformation
```

Expand Down Expand Up @@ -43,7 +42,7 @@ Your `run.py` should follow this structure, demonstrated well in the `generate_t
@codegen.function("your-function-name")
def run(codebase: Codebase):
"""Clear docstring explaining what the function does.

Include:
1. Purpose of the function
2. Key steps or transformations
Expand Down Expand Up @@ -128,7 +127,7 @@ def get_function_context(function) -> dict:
@codegen.function("generate-training-data")
def run(codebase: Codebase):
"""Generate training data using a node2vec-like approach...

This codemod:
1. Finds all functions...
2. For each function...
Expand Down
Loading