Skip to content

Commit

Permalink
Typos in readme (#3)
Browse files Browse the repository at this point in the history
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
Greedquest and pre-commit-ci[bot] committed Jan 13, 2023
1 parent b8173db commit eb64ef5
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This repo follows Test Driven Development. As such all of its features are self

- [Default Categoriser tests](src/Watcher_DefaultCat_tests.bas)
- [_NoCache_ Categoriser tests](src/Watcher_NoCacheCat_tests.bas)

## Quickstart
Clone Repo or download as Zip (see https://github.com/Greedquest/ListObject-WithEvents/issues/2 for details on Zip download). Then add all the files to your project by clicking and dragging onto the project explorer. Ignore `.doccls` files and `_tests` files unless testing (see below).

Expand All @@ -30,7 +30,6 @@ TableWatcher.Create(ByVal srcTable As ListObject, Optional ByVal eventsCategoris
2 categorisers are provided to get you started:
1. [DefaultCategoriser](src/DefaultCategoriser.cls) which is the default, provides the richest set of events. However it keeps track of the dimensions of the ListObject to achieve this - if `Application.EventsEnabled = False` and a modification is made to the table then the categoriser gets out of sync and may miscategorise events.
2. [NoCacheCategoriser](src/NoCacheCategoriser.cls) has a smaller subset of events which it raises, but is stateless so doesn't suffer from any cache invalidation if `Application.EventsEnabled` is toggled on/off. (Of course, no events will be triggered when `Application.EventsEnabled = False` by either categoriser)


## Testing
If you wish to run the RD unit tests, you must create a new workbook with 2 sheets. Set the `Name` and `CodeName` properties of the 2 sheets to `TestSheet` and `DemoSheet` respectively. In RD right click in the project explorer and choose `sync->Replcae Contents from Files` and select the entire src directory. This will import all the code including the document modules. Finally create a new excel table on `DemoSheet` it must have at least 3 rows and 3 columns for the tests to run and set its name to `DemoTable`. The Unit tests should then all run successfully.
If you wish to run the RD unit tests, you must create a new workbook with 2 sheets. Set the `Name` and `CodeName` properties of the 2 sheets to `TestSheet` and `DemoSheet` respectively. In RD right click in the project explorer and choose `Sync->Replace Contents from Files` and select the entire src directory. This will import all the code including the document modules. Finally create a new excel table on `DemoSheet` it must have at least 3 rows and 3 columns for the tests to run and set its name to `DemoTable`. The Unit tests should then all run successfully.

0 comments on commit eb64ef5

Please sign in to comment.