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

Update CAMP documentation #25

Open
wants to merge 7 commits into
base: apl-fy24
Choose a base branch
from
Open

Update CAMP documentation #25

wants to merge 7 commits into from

Conversation

mfarina1
Copy link
Collaborator

Addresses #11

@mfarina1 mfarina1 added the documentation Improvements or additions to documentation label Feb 17, 2025
@mfarina1 mfarina1 added this to the CAMP v3.0.0 milestone Feb 17, 2025
@mfarina1 mfarina1 requested a review from BrianSipos February 17, 2025 17:00
@mfarina1 mfarina1 self-assigned this Feb 17, 2025
@mfarina1 mfarina1 linked an issue Feb 17, 2025 that may be closed by this pull request
Update documentation #11
Open
BrianSipos
BrianSipos reviewed Feb 28, 2025
View reviewed changes
Copy link
Member

@BrianSipos BrianSipos left a comment

Choose a reason for hiding this comment

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

Minor feedback but the file listing is probably mismatched with the current repo. I don't know how much value there actually is in putting a file listing in a README, so one option is to just remove it if it's mismatched and doesn't add value to a reader.

@mfarina1
Copy link
Collaborator Author

mfarina1 commented Mar 3, 2025

Minor feedback but the file listing is probably mismatched with the current repo. I don't know how much value there actually is in putting a file listing in a README, so one option is to just remove it if it's mismatched and doesn't add value to a reader.

@BrianSipos do you mean getting rid of the following in the Readme?

INFO:camp.tools.camp:Loading <path_to_yang_file>/<adm.yang>  ...
INFO:camp.tools.camp:Finished loading ADM <adm>
INFO:camp.tools.camp:Generating files under ./
INFO:camp.tools.camp:Generating <adm>.h ...
INFO:camp.tools.camp:done.
INFO:camp.tools.camp:Generating <adm>.c ...
INFO:camp.tools.camp:done.
INFO:camp.tools.camp:Generating <adm>.sql
INFO:camp.tools.camp:done.
[ End of CAmpPython Execution ]

@mfarina1 mfarina1 mentioned this pull request Mar 6, 2025
Open
@BrianSipos BrianSipos force-pushed the 11-update-documentation branch from 4d0748e to 50372c1 Compare March 6, 2025 18:03
@BrianSipos
Copy link
Member

I rebased this branch to hopefully fix CI issues

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

@BrianSipos BrianSipos BrianSipos approved these changes

Assignees

@mfarina1 mfarina1

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
CAMP v3.0.0
Development

Successfully merging this pull request may close these issues.

Update documentation
2 participants
@mfarina1 @BrianSipos