Pkg.jl: Can we have docstring for Pkg.generate()?

Created on 9 Jul 2020  Â·  6Comments  Â·  Source: JuliaLang/Pkg.jl

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

Most helpful comment

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.

All 6 comments

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

I think we should deprecate it or delete it.

I think we should deprecate it or delete it.

Correct.

https://github.com/JuliaLang/Pkg.jl/pull/1496

I don't remember now why I closed it.

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?

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.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

moustachio-belvedere picture moustachio-belvedere  Â·  3Comments

DilumAluthge picture DilumAluthge  Â·  3Comments

cossio picture cossio  Â·  3Comments

omus picture omus  Â·  4Comments

oxinabox picture oxinabox  Â·  3Comments