Skip to content

docs: fix doc comments grammar and punctuation #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aoright wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: fix doc comments grammar and punctuation #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions cors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// cors package is net/http handler to handle CORS related requests
// Package cors is a net/http handler to handle CORS related requests
// as defined by http://www.w3.org/TR/cors/
//
// You can configure it by passing an option struct to cors.New:
Expand Down Expand Up @@ -33,7 +33,7 @@ type Options struct {
// An origin may contain a wildcard (*) to replace 0 or more characters
// (i.e.: http://*.domain.com). Usage of wildcards implies a small performance penalty.
// Only one wildcard can be used per origin.
// Default value is ["*"]
// Default value is ["*"].
AllowedOrigins []string

// AllowOriginFunc is a custom function to validate the origin. It takes the origin
Expand All @@ -45,38 +45,38 @@ type Options struct {
// cross-domain requests. Default value is simple methods (HEAD, GET and POST).
AllowedMethods []string

// AllowedHeaders is list of non simple headers the client is allowed to use with
// AllowedHeaders is a list of non simple headers the client is allowed to use with
// cross-domain requests.
// If the special "*" value is present in the list, all headers will be allowed.
// Default value is [] but "Origin" is always appended to the list.
AllowedHeaders []string

// ExposedHeaders indicates which headers are safe to expose to the API of a CORS
// API specification
// API specification.
ExposedHeaders []string

// AllowCredentials indicates whether the request can include user credentials like
// cookies, HTTP authentication or client side SSL certificates.
AllowCredentials bool

// MaxAge indicates how long (in seconds) the results of a preflight request
// can be cached
// can be cached.
MaxAge int

// OptionsPassthrough instructs preflight to let other potential next handlers to
// process the OPTIONS method. Turn this on if your application handles OPTIONS.
OptionsPassthrough bool

// Debugging flag adds additional output to debug server side CORS issues
// Debug adds additional output to debug server side CORS issues.
Debug bool
}

// Logger generic interface for logger
// Logger is a generic interface for a logger.
type Logger interface {
Printf(string, ...interface{})
}

// Cors http handler
// Cors is a net/http handler to handle CORS requests.
type Cors struct {
// Debug logger
Log Logger
Expand Down