Skip to content

Commit 4175464

Browse files
antonmedvantonmedv
committed
Add real_world docs
1 parent 226bdb0 commit 4175464

File tree

3 files changed

+135
-0
lines changed

3 files changed

+135
-0
lines changed

‎test/real_world/README.md

+119
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
### Variables
2+
| Name | Type |
3+
|------|------|
4+
| AppVersion | `string` |
5+
| CleanMarker | `string` |
6+
| CountryCode | `string` |
7+
| CurrencyCode | `string` |
8+
| DestinationCountry | `string` |
9+
| Features | [UserAgentFeatures](#UserAgentFeatures) |
10+
| GateID | `int` |
11+
| InitializedAt | `int` |
12+
| IsAffiliate | `bool` |
13+
| IsDesktop | `bool` |
14+
| IsMobile | `bool` |
15+
| IsOpenJaw | `bool` |
16+
| KnowEnglish | `bool` |
17+
| Locale | `string` |
18+
| Marker | `string` |
19+
| Market | `string` |
20+
| OriginCountry | `string` |
21+
| Os | `string` |
22+
| OsVersion | `string` |
23+
| Passengers | [Passengers](#Passengers) |
24+
| Random | `float` |
25+
| ReferrerHost | `string` |
26+
| SearchDepth | `int` |
27+
| SearchParamsEnv | [SearchParamsEnv](#SearchParamsEnv) |
28+
| Segments | array([RouteSegment](#RouteSegment)) |
29+
| TravelPayoutsAPI | `bool` |
30+
| TripClass | `string` |
31+
| UserAgentDevice | `string` |
32+
| UserAgentType | `string` |
33+
| UserIP | `string` |
34+
| false | `bool` |
35+
| true | `bool` |
36+
37+
### Functions
38+
| Name | Return type |
39+
|------|-------------|
40+
| all(array(`any`), `func`) | `bool` |
41+
| any(array(`any`), `func`) | `bool` |
42+
| count(array(`any`), `func`) | `int` |
43+
| filter(array(`any`), `func`) | array(`any`) |
44+
| len(array(`any`)) | `int` |
45+
| map(array(`any`), `func`) | array(`any`) |
46+
| none(array(`any`), `func`) | `bool` |
47+
| one(array(`any`), `func`) | `bool` |
48+
49+
### Types
50+
#### DirectFlightsDays
51+
| Field | Type |
52+
|---|---|
53+
| Days | `string` |
54+
| Start | `string` |
55+
56+
#### Passengers
57+
| Field | Type |
58+
|---|---|
59+
| Adults | `int` |
60+
| Children | `int` |
61+
| Infants | `int` |
62+
63+
#### RouteSegment
64+
| Field | Type |
65+
|---|---|
66+
| Date | `string` |
67+
| Destination | `string` |
68+
| DestinationCountry | `string` |
69+
| DestinationName | `string` |
70+
| DirectFlightsDays | [DirectFlightsDays](#DirectFlightsDays) |
71+
| Origin | `string` |
72+
| OriginCountry | `string` |
73+
| OriginName | `string` |
74+
| TranslatedDestination | `string` |
75+
| TranslatedOrigin | `string` |
76+
| UserDestination | `string` |
77+
| UserOrigin | `string` |
78+
79+
#### SearchParamsEnv
80+
| Field | Type |
81+
|---|---|
82+
| AppVersion | `string` |
83+
| CleanMarker | `string` |
84+
| CountryCode | `string` |
85+
| CurrencyCode | `string` |
86+
| DestinationCountry | `string` |
87+
| Features | [UserAgentFeatures](#UserAgentFeatures) |
88+
| GateID | `int` |
89+
| InitializedAt | `int` |
90+
| IsAffiliate | `bool` |
91+
| IsDesktop | `bool` |
92+
| IsMobile | `bool` |
93+
| IsOpenJaw | `bool` |
94+
| KnowEnglish | `bool` |
95+
| Locale | `string` |
96+
| Marker | `string` |
97+
| Market | `string` |
98+
| OriginCountry | `string` |
99+
| Os | `string` |
100+
| OsVersion | `string` |
101+
| Passengers | [Passengers](#Passengers) |
102+
| Random | `float` |
103+
| ReferrerHost | `string` |
104+
| SearchDepth | `int` |
105+
| Segments | array([RouteSegment](#RouteSegment)) |
106+
| TravelPayoutsAPI | `bool` |
107+
| TripClass | `string` |
108+
| UserAgentDevice | `string` |
109+
| UserAgentType | `string` |
110+
| UserIP | `string` |
111+
112+
#### UserAgentFeatures
113+
| Field | Type |
114+
|---|---|
115+
| Assisted | `bool` |
116+
| TopPlacement | `bool` |
117+
| TourTickets | `bool` |
118+
119+

‎test/real_world/real_docs/generate.go

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
package main
2+
3+
import (
4+
"fmt"
5+
6+
"github.com/antonmedv/expr/docgen"
7+
"github.com/antonmedv/expr/test/real_world"
8+
)
9+
10+
func main() {
11+
doc := docgen.CreateDoc(real_world.NewEnv())
12+
13+
fmt.Println(doc.Markdown())
14+
}

‎test/real_world/real_world.go

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
package real_world
22

3+
//go:generate sh -c "go run ./real_docs/generate.go > README.md"
4+
35
type DirectFlightsDays struct {
46
Start string
57
Days string

0 commit comments

Comments
 (0)