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

Print the available targets and variables along w/ their docs #81

Open
bahmanm opened this issue Sep 30, 2023 · 2 comments
Open

Print the available targets and variables along w/ their docs #81

bahmanm opened this issue Sep 30, 2023 · 2 comments
Labels
💡 idea Needs investigation/research

Comments

@bahmanm
Copy link
Owner

bahmanm commented Sep 30, 2023

bmakelib should contain a target to list all available targets along w/ their documentation.

For example:

$ make bmakelib.help
TARGETS
-------
foo:  foo inline docs
bar:  bar inline docs
baz:  no documentation available

VARIABLES
---------
X:  no documentation available
Y:  Y inline docs
@bahmanm bahmanm added ✅ enhancement New feature or request 💡 idea Needs investigation/research and removed ✅ enhancement New feature or request labels Sep 30, 2023
@ACleverDisguise
Copy link

I would kill for this feature.

@bahmanm
Copy link
Owner Author

bahmanm commented Oct 5, 2023

It shouldn't be too difficult w/ a bit of Perl magic. However, we'd need to make a compromise and only support certain ways of documenting targets.

I'm not sure what could be considered a common style(s) of that.


I'm seen people do

foo:  ## lorem ipsum dolor

or

# lorem ipsum dolor
foo: 

and there's also my personal style using Markdown. for an example see

#######################################################################
#>
#   # foo
#
#   Lorem ipsum dolor.
#   Aliquam diam sapien, suscipit ac ligula a, cursus tempus ante. 
#<
#######################################################################

foo :

For the first version, I think as soon as we choose which style is the preferred one, I can get started w/ this.

@bahmanm bahmanm removed the ✅ enhancement New feature or request label Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💡 idea Needs investigation/research
Projects
None yet
Development

No branches or pull requests

2 participants