Skip to content

Commit dbfef88

Browse files
committed
Change style of Markdown heading syntax
1 parent 4b5d2ae commit dbfef88

File tree

1 file changed

+11
-20
lines changed

1 file changed

+11
-20
lines changed

README.md

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
Sidetrack<img width="11%" align="right" src="https://github.com/caltechlibrary/sidetrack/raw/main/.graphics/sidetrack-logo.png">
2-
===========================================================================
1+
# Sidetrack<img width="11%" align="right" src="https://github.com/caltechlibrary/sidetrack/raw/main/.graphics/sidetrack-logo.png">
32

43
_Sidetrack_ provides a simple interface for writing log messages in Python programs. Calls to the log functions can be left in your code to let users produce debug logs in the field; if performance matters, using certain coding idioms and turning on Python optimization will cause log statements to be compiled out.
54

@@ -10,8 +9,7 @@ _Sidetrack_ provides a simple interface for writing log messages in Python progr
109
[![PyPI](https://img.shields.io/pypi/v/sidetrack.svg?style=flat-square&color=red)](https://pypi.org/project/sidetrack/)
1110

1211

13-
Table of contents
14-
-----------------
12+
## Table of contents
1513

1614
* [Introduction](#introduction)
1715
* [Installation](#installation)
@@ -23,8 +21,7 @@ Table of contents
2321
* [Acknowledgments](#authors-and-acknowledgments)
2422

2523

26-
Introduction
27-
------------
24+
## Introduction
2825

2926
IDEs are great for debugging and tracing execution of your code, but they can't be used in all situations. For example, if your code is executing on multiple remote computers, or you have released a program to general users and you would like them to send you a debug log/trace of execution, using an IDE at run time may be impractical or impossible. Logging packages such as [`logging`](https://docs.python.org/3/library/logging.html) are made for these situations; you can insert logging statements in your code and use the output to understand what is happening as well as for software telemetry and other purposes. However, setting up Python [`logging`](https://docs.python.org/3/library/logging.html) or most similar packages is (IMHO) complicated and verbose if you don't need all its features.
3027

@@ -40,8 +37,8 @@ for item in item_list:
4037
When running with `-O`, the `log` statement in the loop will not simply be a no-op function call: Python will [completely discard the conditional block](https://www.engyrus.com/2013/03/idtkap-4-debug-and-o.html), as if the code did not exist. This is as optimal as possible, and means that you do not have to worry about the performance costs of using `log` or evaluating its arguments.
4138

4239

43-
Installation
44-
------------
40+
## Installation
41+
4542

4643
The instructions below assume you have a Python interpreter installed on your computer; if that's not the case, please first [install Python version 3](INSTALL-Python3.md) and familiarize yourself with running Python programs on your system.
4744

@@ -56,8 +53,7 @@ python3 -m pip install git+https://github.com/caltechlibrary/sidetrack.git
5653
```
5754

5855

59-
Usage
60-
-----
56+
## Usage
6157

6258
There are just three functions in the `sidetrack` package:
6359
* `set_debug`: turn logging on/off, set the output destination, and configure options
@@ -208,32 +204,27 @@ python3 -O tests/demo_debug.py -d -
208204
```
209205

210206

211-
Getting help
212-
------------
207+
## Getting help
213208

214209
If you find an issue, please submit it in [the GitHub issue tracker](https://github.com/caltechlibrary/sidetrack/issues) for this repository.
215210

216211

217-
Contributing
218-
------------
212+
## Contributing
219213

220214
We would be happy to receive your help and participation with enhancing `sidetrack`! Please visit the [guidelines for contributing](CONTRIBUTING.md) for some tips on getting started.
221215

222216

223-
License
224-
-------
217+
## License
225218

226219
Software produced by the Caltech Library is Copyright (C) 2020, Caltech. This software is freely distributed under a BSD/MIT type license. Please see the [LICENSE](LICENSE) file for more information.
227220

228221

229-
Authors and history
230-
---------------------------
222+
## Authors and history
231223

232224
I developed the first version of this code while implementing [Spiral](https://github.com/casics/spiral). I started using the code in essentially every Python software package I have written since then, first by copy-pasting the code (which was initially very short) and eventually creating a single-file module (named `debug.py`). This was obviously a suboptimal approach. Finally, in 2020, I decided it was time to break it out into a proper self-contained Python package.
233225

234226

235-
Acknowledgments
236-
---------------
227+
## Acknowledgments
237228

238229
This work was funded by the California Institute of Technology Library.
239230

0 commit comments

Comments
 (0)