Skip to content

Commit 324194c

Browse files
authored
Fix fomatting of nested list in "workflow tips" section of the manual, fixes #37599 (#37600)
1 parent d587f9d commit 324194c

File tree

1 file changed

+30
-29
lines changed

1 file changed

+30
-29
lines changed

doc/src/manual/workflow-tips.md

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -83,35 +83,36 @@ the following modifications:
8383
1. Put your code in a module somewhere on your load path. There are
8484
several options for achieving this, of which two recommended choices are:
8585

86-
a. For long-term projects, use
87-
[PkgTemplates](https://github.com/invenia/PkgTemplates.jl):
88-
89-
```julia
90-
using PkgTemplates
91-
t = Template()
92-
t("MyPkg")
93-
```
94-
This will create a blank package, `"MyPkg"`, in your `.julia/dev` directory.
95-
Note that PkgTemplates allows you to control many different options
96-
through its `Template` constructor.
97-
98-
In step 2 below, edit `MyPkg/src/MyPkg.jl` to change the source code, and
99-
`MyPkg/test/runtests.jl` for the tests.
100-
101-
b. For "throw-away" projects, you can avoid any need for cleanup
102-
by doing your work in your temporary directory (e.g., `/tmp`).
103-
104-
Navigate to your temporary directory and launch Julia, then do the following:
105-
106-
```julia
107-
pkg> generate MyPkg # type ] to enter pkg mode
108-
julia> push!(LOAD_PATH, pwd()) # hit backspace to exit pkg mode
109-
```
110-
If you restart your Julia session you'll have to re-issue that command
111-
modifying `LOAD_PATH`.
112-
113-
In step 2 below, edit `MyPkg/src/MyPkg.jl` to change the source code, and create any
114-
test file of your choosing.
86+
- For long-term projects, use
87+
[PkgTemplates](https://github.com/invenia/PkgTemplates.jl):
88+
89+
```julia
90+
using PkgTemplates
91+
t = Template()
92+
t("MyPkg")
93+
```
94+
95+
This will create a blank package, `"MyPkg"`, in your `.julia/dev` directory.
96+
Note that PkgTemplates allows you to control many different options
97+
through its `Template` constructor.
98+
99+
In step 2 below, edit `MyPkg/src/MyPkg.jl` to change the source code, and
100+
`MyPkg/test/runtests.jl` for the tests.
101+
102+
- For "throw-away" projects, you can avoid any need for cleanup
103+
by doing your work in your temporary directory (e.g., `/tmp`).
104+
105+
Navigate to your temporary directory and launch Julia, then do the following:
106+
107+
```julia
108+
pkg> generate MyPkg # type ] to enter pkg mode
109+
julia> push!(LOAD_PATH, pwd()) # hit backspace to exit pkg mode
110+
```
111+
If you restart your Julia session you'll have to re-issue that command
112+
modifying `LOAD_PATH`.
113+
114+
In step 2 below, edit `MyPkg/src/MyPkg.jl` to change the source code, and create any
115+
test file of your choosing.
115116

116117
2. Develop your package
117118

0 commit comments

Comments
 (0)