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

Implement PoC of Makefile target documentation pattern #2007

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

eecavanna
Copy link
Collaborator

@eecavanna eecavanna commented May 26, 2024

Example usage

$ make

(...)

cookiecutter-help: Show targets inherited from cookiecutter
status: Show project metadata
migration-doctests: Run migration-related doctests
migrator: Generate a migrator interactively

$

Screenshot of output:

image

@eecavanna eecavanna self-assigned this May 26, 2024
@eecavanna eecavanna linked an issue May 26, 2024 that may be closed by this pull request
@eecavanna
Copy link
Collaborator Author

Hi @turbomam, I have updated this branch to contain the additional #// ... documentation lines we came up with during today's hackathon.

Here's a screenshot of the current output of make help (minus the boilerplate content included at the top of the output):

image

@eecavanna
Copy link
Collaborator Author

I'm going to mark this as ready for review, since the "plumbing" is implemented in this PR branch. People can add the specific documentation comments in a separate PR.

@eecavanna eecavanna marked this pull request as ready for review July 18, 2024 02:16
@eecavanna eecavanna requested a review from turbomam July 18, 2024 02:16
@eecavanna
Copy link
Collaborator Author

To consider:

  • Move the sed script to a dedicated make target (instead of piggybacking onto the help target, given the latter's baggage)
  • Using something other than sed (e.g. a Python script)

@turbomam turbomam deleted the branch main October 16, 2024 15:15
@turbomam turbomam closed this Oct 16, 2024
@eecavanna eecavanna reopened this Oct 17, 2024
@eecavanna
Copy link
Collaborator Author

Reopening because I assume this was closed unintentionally as part of today's "accidental closure of several PR" (an event that was mentioned in Slack). I'm OOO today.

@eecavanna eecavanna changed the base branch from main-old to main October 18, 2024 22:42
@eecavanna
Copy link
Collaborator Author

I will replicate this PR (effectively) in the upstream nmdc-schema repo and then close this PR here.

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.

Document all targets in project.Makefile
2 participants