Skip to content

Commit 95daa68

Browse files
committed
Prettify package commentary
* README.md: Fixup headers to be consistent. * compiler-explorer.el: Regenerate commentary. * Makefile (readme-to-el): Rewrite headers into org style.
1 parent b2ea96c commit 95daa68

File tree

3 files changed

+17
-13
lines changed

3 files changed

+17
-13
lines changed

Makefile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,9 @@ sandbox: ${ELC}
9494

9595
readme-to-el:
9696
sed README.md -r \
97-
-e 's/^#+ (.*) #*$$/\n;;; \1/' `# Rewrite headers` \
97+
-e 's/^### (.*) #*$$/\n;; *** \1/' `# Rewrite headers` \
98+
-e 's/^## (.*) #*$$/\n;;; ** \1/' `# Rewrite headers` \
99+
-e 's/^#+ (.*) #*$$/\n;; * \1/' `# Rewrite headers` \
98100
-e '/^.*License.*/,/^<!/d' `# Delete license` \
99101
-e '/^<!--/d' `# Remove comments` \
100102
-e '/```elisp/,/^```/ s/(.*)/ \1/' `# Indent code` \

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,12 @@ generated by the website or by this package.
7373

7474
`M-x compiler-explorer-layout` cycles between different layouts.
7575

76-
## Customization
76+
## Customization ##
7777

7878
Additional customization is possible via `M-x customize-group`
7979
`compiler-explorer`.
8080

81-
### Usage with language servers
81+
### Usage with language servers ###
8282

8383
The following snippet sets up the built-in eglot package to start a language
8484
server for each session, and to automatically create and update a

compiler-explorer.el

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@
2828
;;; Commentary:
2929

3030
;;
31-
;;; compiler-explorer.el
31+
;; * compiler-explorer.el
3232
;;
3333
;; Package that provides a client for https://godbolt.org service.
3434
;;
3535
;;
36-
;;; Usage
36+
;;; ** Usage
3737
;;
3838
;; M-x `compiler-explorer' is the main entry point. It will ask you for a
3939
;; language and display source&compilation buffers. Type something in the
@@ -42,7 +42,7 @@
4242
;; executed program.
4343
;;
4444
;;
45-
;;; Compilation
45+
;; *** Compilation
4646
;;
4747
;; M-x `compiler-explorer-set-compiler' changes the compiler for current
4848
;; session.
@@ -54,7 +54,7 @@
5454
;; removes them.
5555
;;
5656
;;
57-
;;; Execution
57+
;; *** Execution
5858
;;
5959
;; M-x `compiler-explorer-set-execution-args' sets the arguments for the
6060
;; executed program.
@@ -63,7 +63,7 @@
6363
;; will be used as input for the executed program.
6464
;;
6565
;;
66-
;;; Session management
66+
;; *** Session management
6767
;;
6868
;; M-x `compiler-explorer-new-session' kills the current session and
6969
;; creates a new one, asking for source language.
@@ -77,7 +77,7 @@
7777
;; M-x `compiler-explorer-exit' kills the current session.
7878
;;
7979
;;
80-
;;; ASM
80+
;; *** ASM
8181
;;
8282
;; M-x `compiler-explorer-browse-opcode-documentation' opens a website
8383
;; that contains the documentation for the opcode at point.
@@ -86,7 +86,7 @@
8686
;; point and vice versa.
8787
;;
8888
;;
89-
;;; Tools
89+
;; *** Tools
9090
;;
9191
;; M-x `compiler-explorer-add-tool' asks for the name of a tool, adds it
9292
;; to current compilation and displays a new buffer showing the tool's
@@ -103,7 +103,7 @@
103103
;;
104104
;;
105105
;;
106-
;;; Other commands
106+
;; *** Other commands
107107
;;
108108
;; M-x `compiler-explorer-load-example' prompts for a name of a builtin
109109
;; example and loads it.
@@ -116,12 +116,14 @@
116116
;;
117117
;; M-x `compiler-explorer-layout' cycles between different layouts.
118118
;;
119-
;; ## Customization
119+
;;
120+
;;; ** Customization
120121
;;
121122
;; Additional customization is possible via M-x `customize-group'
122123
;; `compiler-explorer'.
123124
;;
124-
;; ### Usage with language servers
125+
;;
126+
;; *** Usage with language servers
125127
;;
126128
;; The following snippet sets up the built-in eglot package to start a
127129
;; language server for each session, and to automatically create and

0 commit comments

Comments
 (0)