Beginning concept documentation

This commit is contained in:
Daniel Ziltener 2022-05-12 01:32:29 +02:00
parent acb3d8a526
commit 9fb2cd86d2
3 changed files with 48 additions and 1 deletions

View file

@ -1,7 +1,7 @@
Class {
#name : #BaselineOfBowerbird,
#superclass : #BaselineOf,
#category : #BaselineOfBowerbird
#category : #'BaselineOfBowerbird-Base'
}
{ #category : #baselines }

View file

@ -0,0 +1,23 @@
"
Please describe the package using the class comment of the included manifest class. The manifest class also includes other additional metadata for the package. These meta data are used by other tools such as the SmalllintManifestChecker and the critics Browser
"
Class {
#name : #ManifestBaselineOfBowerbird,
#superclass : #PackageManifest,
#category : #'BaselineOfBowerbird-Manifest'
}
{ #category : #'code-critics' }
ManifestBaselineOfBowerbird class >> ruleClassNotReferencedRuleV1FalsePositive [
^ #(#(#(#RGPackageDefinition #(#BaselineOfBowerbird)) #'2022-05-12T00:22:29.252518+02:00') )
]
{ #category : #'code-critics' }
ManifestBaselineOfBowerbird class >> ruleNoClassCommentRuleV1FalsePositive [
^ #(#(#(#RGPackageDefinition #(#BaselineOfBowerbird)) #'2022-05-12T00:22:24.54493+02:00') )
]
{ #category : #'code-critics' }
ManifestBaselineOfBowerbird class >> ruleUtilityMethodsRuleV1FalsePositive [
^ #(#(#(#RGPackageDefinition #(#BaselineOfBowerbird)) #'2022-05-12T00:21:18.399176+02:00') )
]

View file

@ -0,0 +1,24 @@
"
The Bowerbird is a powerful crawling tool, with a focus on web crawling. It features an extendable, flexible graphical DSL.
## Structure
A crawler consists of a few identifying properties and blocks that pass data to each other. The properties are:
| Property | Example | Description |
|----------|---------------|-------------|
| name | SilkBowerbird | A name for the crawler, used as its class name. |
| matcher | | A one-argument lambda checking if the crawler is applicable. |
## Block And Command System
Blocks are the controlling entity in a crawler, and contain individual commands. Blocks manage things like fetching resources from URLs, calling appropriate parsers, calling the commands, and ultimately returning the compiled data for the next block to handle.
Commands on the other hand are much narrower in scope. They do things like split up documents and extract and assemble data points.
"
Class {
#name : #ManifestBowerbird,
#superclass : #PackageManifest,
#category : #'Bowerbird-Manifest'
}