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

Can we have docstring for Pkg.generate()? #1917

Closed
anandijain opened this issue Jul 9, 2020 · 6 comments · Fixed by #2492
Closed

Can we have docstring for Pkg.generate()? #1917

anandijain opened this issue Jul 9, 2020 · 6 comments · Fixed by #2492

Comments

@anandijain
Copy link

I think it'd be nice to have a docstring for Pkg.generate()

I don't know the standards for writing docstrings (why I submitted issue not PR), but something like:

Pkg.generate(...)

Creates a new project with the following files (visualized with the external tree command):

shell> tree .
.
├── YourPkg
│   ├── Project.toml
│   └── src
│       └── YourPkg.jl

1 directory, 2 files
@KristofferC
Copy link
Member

Might be better off just using https://github.com/invenia/PkgTemplates.jl.

@StefanKarpinski
Copy link
Member

I think we should deprecate it or delete it.

@DilumAluthge
Copy link
Member

I think we should deprecate it or delete it.

Correct.

@DilumAluthge
Copy link
Member

#1496

I don't remember now why I closed it.

@anandijain
Copy link
Author

Thanks, PkgTemplates seems to have a lot of functionality!

I agree with this comment in #1496, that it would be nice to still have REPL functionality.

Any way to have best of both worlds?

@DilumAluthge
Copy link
Member

PkgTemplates has an interactive wizard.

If someone wants additional REPL functionality beyond what is available in PkgTemplates, I'm sure that Chris would be happy to accept pull requests to enhance PkgTemplates. Alternatively, someone could make a new package that implemented the REPL functionality.

The ReplMaker package may be helpful for building REPL functionality.

Anyway, I don't think this functionality needs to live in Pkg.

@StefanKarpinski I'll make a new PR to deprecate Pkg.generate.

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 a pull request may close this issue.

4 participants