fix english syntax

Signed-off-by: Augustin Husson <husson.augustin@gmail.com>

Author: Nexucis

rest/api.go

@@ -37,13 +37,13 @@ func returnJSON(w http.ResponseWriter, content interface{}) {
 }
 
 type lspData struct {
-	// Expr is the promQL expression and is required for all endpoint available.
+	// Expr is the PromQL expression and is required for all endpoints available.
 	Expr string `json:"expr"`
-	// Limit is the number max of result returned to the client. It will be used for the autocompletion and the diagnostics.
+	// Limit is the maximum number of results returned to the client. It will be used for autocompletion and diagnostics.
 	Limit *uint64 `json:"limit,omitempty"`
 	// PositionLine is the number of the line for which the metadata is queried.
 	PositionLine *float64 `json:"positionLine,omitempty"`
-	// PositionChar for which the metadata is queried. Characters are counted as UTF16 Codepoints.
+	// PositionChar for which the metadata is queried. Characters are counted as UTF-16 code points.
 	PositionChar *float64 `json:"positionChar,omitempty"`
 }
 
@@ -54,7 +54,7 @@ func (d *lspData) UnmarshalJSON(data []byte) error {
 		return err
 	}
 	if len(tmp.Expr) == 0 {
-		return fmt.Errorf("promQL expression is not specified")
+		return fmt.Errorf("PromQL expression is not specified")
 	}
 	*d = tmp
 	return nil
@@ -73,22 +73,24 @@ func (d *lspData) returnPosition() (protocol.Position, error) {
 	}, nil
 }
 
+// API is the struct that manages the different endpoint provided by the langServer.
+// It also takes care of creating all necessary HTTP middleware.
 type API struct {
 	langServer    langserver.HeadlessServer
 	mdws          []middlewareFunc
 	enableMetrics bool
 }
 
-// NewLangServerAPI create a new instance of the Stateless API to use the LangServer through HTTP.
+// NewLangServerAPI creates a new instance of the Stateless API to use the LangServer through HTTP.
 //
 // If metadata is fetched from a remote Prometheus, the metadataService
 // implementation from the promql-langserver/prometheus package can be used,
 // otherwise you need to provide your own implementation of the interface.
 //
 // The provided Logger should be synchronized.
 //
-// In case "enableMetrics" is set to true, endpoint /metrics is then available and a middleware that instrument the different endpoints provided is instantiated.
-// Don't use it in case you have already in place such middleware.
+// In case "enableMetrics" is set to true, endpoint /metrics is then available and a middleware that instruments the different endpoints provided is instantiated.
+// Don't use it in case you already have such middleware in place.
 func NewLangServerAPI(ctx context.Context, metadataService promClient.MetadataService, logger log.Logger, enableMetrics bool) (*API, error) {
 	lgs, err := langserver.CreateHeadlessServer(ctx, metadataService, logger)
 	if err != nil {

rest/doc.go

@@ -26,10 +26,10 @@ Supported endpoints:
 All endpoint are only available through the HTTP method POST. For each request, you have to provide the following JSON:
 
 {
-  "expr": "a promQL expression" # Mandatory for all available endpoint
-  "limit": 45 # Optional. It will be used only for the endpoint /diagnostics and /completion. It's the maximum number of result returned.
+  "expr": "a PromQL expression" # Mandatory for all available endpoints
+  "limit": 45  # Optional. It will be used only for the endpoints /diagnostics and /completion. It's the maximum number of result returned.
   "positionLine": 0 # Mandatory for the endpoints /signatureHelp, /hover and /completion. The line (0 based) for which the metadata is queried.
-  "positionChar": 2 # Mandatory for the endpoints /signatureHelp, /hover and /completion. The column (0 based) for which the metadata is queried. Characters are counted as UTF16 Codepoints.
+  "positionChar": 2 # Mandatory for the endpoints /signatureHelp, /hover and /completion. The column (0 based) for which the metadata is queried. Characters are counted as UTF-16 code points.
 }
 
 

rest/middleware.go

@@ -46,7 +46,7 @@ func getRequestID(ctx context.Context) (protocol.DocumentURI, error) {
 	return "", fmt.Errorf("unable to retrieve the requestID")
 }
 
-// injectRequestData will create a new context and add to this new one the data passed as parameter.
+// injectRequestData will create a new context and add to this new one to the data passed as parameter.
 func injectRequestData(ctx context.Context, data *lspData) context.Context {
 	return context.WithValue(ctx, contextKeyRequestData, data)
 }
@@ -81,7 +81,7 @@ type middlewareFunc func(http.HandlerFunc) http.HandlerFunc
 func manageDocumentMiddleware(langServer langserver.HeadlessServer) middlewareFunc {
 	return func(next http.HandlerFunc) http.HandlerFunc {
 		return func(w http.ResponseWriter, r *http.Request) {
-			// start to generate an unique ID for the given request
+			// start to generate a unique ID for the given request
 			id, err := uuid.NewRandom()
 			if err != nil {
 				http.Error(w, err.Error(), http.StatusInternalServerError)
@@ -91,7 +91,7 @@ func manageDocumentMiddleware(langServer langserver.HeadlessServer) middlewareFu
 			// then inject it in the http request context
 			r = r.WithContext(injectRequestID(r.Context(), requestID))
 
-			// then unmarshall the body to the proper struct to be able to retrieve the promQL expr
+			// then unmarshal the body to the proper struct to be able to retrieve the PromQL expr
 			data := &lspData{}
 			if err := json.NewDecoder(r.Body).Decode(data); err != nil {
 				if err == io.EOF {