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

self-documenting shell functions #23

Closed
sinewalker opened this issue May 30, 2017 · 4 comments
Closed

self-documenting shell functions #23

sinewalker opened this issue May 30, 2017 · 4 comments
Assignees
@sinewalker
Labels
enhancement
Projects
macOS
Milestone
1.0-macOS

Comments

@sinewalker
Copy link
Owner

I need to complete moving all the comments into $FUNCDESC variables.

The main motivation for this is so that I can tell from a simple whence funcname how to use the function (since type -a prints the actual definition, and a comment in $FUNCDESC will be part of that).

If possible I would also like to mimmic emacs' "defined in blah.el" so I can quickly locate the code in the dotfiles tree. Not sure if/how that can be done
@sinewalker sinewalker added this to the 1.0-macOS milestone May 30, 2017
@sinewalker
Copy link
Owner Author

Once I work it all out, I should also document this in the wiki

@sinewalker sinewalker self-assigned this May 30, 2017
@sinewalker sinewalker mentioned this issue May 31, 2017
Closed
@sinewalker
Copy link
Owner Author

sinewalker commented May 31, 2017 •
edited

Some interesting notes on this idea

@sinewalker sinewalker assigned sinewalker and unassigned sinewalker Aug 22, 2017
@sinewalker sinewalker added this to TODO in macOS Aug 22, 2017
@sinewalker sinewalker mentioned this issue Oct 14, 2017
Open
sinewalker added a commit that referenced this issue Oct 16, 2017
@sinewalker
add function description to dedupe_path()
9356521 
Also clean up variable references

Issue #23
Issue #24
sinewalker added a commit that referenced this issue Oct 17, 2017
@sinewalker
fix more variable reference issues
0339f8a 
Issue #23
@sinewalker
Copy link
Owner Author

Documented on the Wiki

@sinewalker
Copy link
Owner Author

I think this is ready to close: all current interactive functions have $FUNCDESC, most also make calls to ussage

@sinewalker sinewalker moved this from TODO to done in macOS Mar 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sinewalker sinewalker

Labels
enhancement
Projects
No open projects
macOS
done
Milestone
1.0-macOS
Development

No branches or pull requests
1 participant
@sinewalker