{"size": 1585, "ext": "scrbl", "max_stars_repo_path": "syntax-warn-doc/main.scrbl", "max_stars_repo_name": "jackfirth/syntax-warn", "max_stars_repo_stars_event_min_datetime": "2016-09-14T03:12:52.000Z", "max_stars_repo_stars_event_max_datetime": "2020-06-29T18:26:57.000Z", "max_issues_repo_path": "syntax-warn-doc/main.scrbl", "max_issues_repo_name": "jackfirth/syntax-warn", "max_issues_repo_issues_event_min_datetime": "2016-08-12T01:09:00.000Z", "max_issues_repo_issues_event_max_datetime": "2017-08-16T04:17:01.000Z", "max_forks_repo_path": "syntax-warn-doc/main.scrbl", "max_forks_repo_name": "jackfirth/syntax-warn", "max_forks_repo_forks_event_min_datetime": "2016-08-12T02:09:59.000Z", "max_forks_repo_forks_event_max_datetime": "2019-02-26T17:42:32.000Z"}
{"max_stars_count": 7, "max_issues_count": 108, "max_forks_count": 6, "avg_line_length": 40.641025641, "max_line_length": 80, "alphanum_fraction": 0.7659305994}
#lang scribble/manual

@(require "base.rkt")

@title[#:style '(toc)]{Syntax Warnings}
@author[@author+email["Jack Firth" "jackhfirth@gmail.com"]]

This library includes forms and functions for working with syntax warnings.
@warn-tech-definition{A syntax warning} is a compile-time source code annotation
meant to draw attention to potential defects. Syntax warnings can be used to
point out bad code style, sub-optimal constructs, excessively verbose code, or
use of deprecated features. Additionally included in this library are the
@exec{raco warn} and @exec{raco fix} commands for finding and fixing warnings,
and the @hash-lang[] @racketmodname[racket/base/warn] language which provides
many forms in @racketmodname[racket/base] with warnings attached in various
ways.

@source-code-link{https://github.com/jackfirth/syntax-warn}

This library is provided as several packages. These packages are organized as
follows:

@itemize[
 @item{@package-name{syntax-warn-base} --- The core API of syntax warnings, as
  defined by the @racketmodname[syntax/warn] module.}
 @item{@package-name{syntax-warn-cli} --- The @exec{raco} command line tools for
  working with warnings.}
 @item{@package-name{syntax-warn-lang} --- The @racketmodname[racket/base/warn]
  language.}
 @item{@package-name{syntax-warn-doc} --- The documentation part of the
  library.}
 @item{@package-name{syntax-warn} --- A wrapper package that implies
  installation of all of the above packages.}]

@table-of-contents[]
@include-section["reference.scrbl"]
@include-section["cli.scrbl"]
@include-section["lang.scrbl"]
