Skip to content

Commit f055d82

Browse files
Merge branch 'develop-typos'. Close #587.
**Description** The package `copilot-core` contains a comment that ends in double period, which is just a typo. Similar errors are present in `copilot-language` and `copilot-theorem`. **Type** - Bug: Typo in documentation. **Additional context** None. **Requester** - Ivan Perez. **Method to check presence of bug** The errors can be located with: ``` $ grep -nHre '--.*[^\.,0-9 ]\.\.' copilot**/src copilot-core/src/Copilot/Core/Spec.hs:16:-- representations for Specs and the main types of element in a spec.. copilot-language/src/Copilot/Language/Operators/Projection.hs:26:-- of type t carried in a stream of type d.. copilot-theorem/src/Copilot/Theorem/Misc/SExpr.hs:34:-- additional expressions or arguments.. ``` The following Dockerfile reports as errors any double periods at the end of a sentence where the sequence is not part of an ellipsis or range definition, printing the word "Success" if none are found: ``` FROM ubuntu:focal ENV DEBIAN_FRONTEND=noninteractive RUN apt-get update RUN apt-get install --yes git SHELL ["/bin/bash", "-c"] CMD git clone $REPO \ && cd $NAME \ && git checkout $COMMIT \ && ! grep -nHre '--.*[^\.,0-9 ]\.\.' copilot**/src \ && echo Success ``` **Expected result** Running the dockerfile above prints the message "Success", indicating that there is no comment that ends with double period that is not part of an ellipsis or enumeration. **Solution implemented** Remove the double period from the comments listed above. **Further notes** None.
2 parents 34f16e8 + 0d9214e commit f055d82

File tree

6 files changed

+11
-4
lines changed

6 files changed

+11
-4
lines changed

copilot-core/CHANGELOG

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
2025-01-28
2+
* Fix typo in documentation. (#587)
3+
14
2025-01-07
25
* Version bump (4.2). (#577)
36
* Deprecate fields of Copilot.Core.Expr.UExpr. (#565)

copilot-core/src/Copilot/Core/Spec.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
--
1414
-- In order to be executed, high-level Copilot Language Spec must be turned
1515
-- into Copilot Core's 'Spec'. This module defines the low-level Copilot Core
16-
-- representations for Specs and the main types of element in a spec..
16+
-- representations for Specs and the main types of element in a spec.
1717
module Copilot.Core.Spec
1818
( Stream (..)
1919
, Observer (..)

copilot-language/CHANGELOG

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
2025-01-28
2+
* Fix typo in documentation. (#587)
3+
14
2025-01-07
25
* Version bump (4.2). (#577)
36
* Bump upper version constraint on containers. (#570)

copilot-language/src/Copilot/Language/Operators/Projection.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ infixl 8 =$
2323
-- | Common interface to manipulate portions of a larger data structure.
2424
--
2525
-- A projectable d s t means that it is possible to manipulate a sub-element s
26-
-- of type t carried in a stream of type d..
26+
-- of type t carried in a stream of type d.
2727
class Projectable d s t | d s -> t where
2828

2929
-- | Unapplied projection or element access on a type.

copilot-theorem/CHANGELOG

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
2025-01-25
1+
2025-01-28
22
* Fix multiple typos in README. (#560)
3+
* Fix typo in documentation. (#587)
34

45
2025-01-07
56
* Version bump (4.2). (#577)

copilot-theorem/src/Copilot/Theorem/Misc/SExpr.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ singleton a = List [Atom a] -- (s)
3131
list = List -- (ss)
3232

3333
-- | Sequence of expressions with a root or main note, and a series of
34-
-- additional expressions or arguments..
34+
-- additional expressions or arguments.
3535
node a l = List (Atom a : l) -- (s ss)
3636

3737
-- A straightforward string representation for 'SExpr's of Strings that

0 commit comments

Comments
 (0)