Skip to content

Commit

Permalink
Clarify column descriptions (#13)
Browse files Browse the repository at this point in the history 
* clarify col desc

* standardize to directions
  • Loading branch information
@wendy-aw
wendy-aw authored Feb 20, 2024
1 parent b3a0037 commit 707df36
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 33 deletions.
10 changes: 5 additions & 5 deletions defog_data/advising/advising.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -172,12 +172,12 @@
{
"data_type": "text",
"column_name": "degree",
"column_description": "Degree program the student is enrolled in"
"column_description": "Degree program the student is enrolled in. Can only be 'Bachelor of Science' or 'Bachelor of Arts'."
},
{
"data_type": "text",
"column_name": "entered_as",
"column_description": "Status of the student when they entered the program"
"column_description": "Status of the student when they entered the program. e.g. 'Freshman', 'Transfer Student'"
},
{
"data_type": "text",
Expand Down Expand Up @@ -219,7 +219,7 @@
{
"data_type": "text",
"column_name": "semester",
"column_description": "The name or identifier for the semester (e.g. Fall, Spring, Summer)"
"column_description": "The name or identifier for the semester Can only be 'Fall', 'Spring', or 'Summer'"
}
],
"instructor": [
Expand Down Expand Up @@ -258,7 +258,7 @@
{
"data_type": "text",
"column_name": "category",
"column_description": "The category of the course"
"column_description": "The category of the course. Can only be 'Core' or 'Elective'."
}
],
"student_record": [
Expand All @@ -285,7 +285,7 @@
{
"data_type": "text",
"column_name": "how",
"column_description": "How the student took the course (e.g. in-person, online)"
"column_description": "How the student took the course. Can only be 'in-person' or 'online'."
},
{
"data_type": "text",
Expand Down
34 changes: 17 additions & 17 deletions defog_data/atis/atis.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
{
"data_type": "text",
"column_name": "state_code",
"column_description": "The code assigned to the state where the city is located"
"column_description": "The 2-letter code assigned to the state where the city is located. E.g. 'NY', 'CA', etc."
},
{
"data_type": "text",
Expand All @@ -36,7 +36,7 @@
{
"data_type": "text",
"column_name": "day_name",
"column_description": "The name of a day of the week"
"column_description": "The name of a day of the week. Either 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', or 'Sunday'."
}
],
"fare": [
Expand Down Expand Up @@ -102,7 +102,7 @@
{
"data_type": "text",
"column_name": "state_code",
"column_description": "The code representing the state"
"column_description": "The 2-letter code assigned to the state. E.g. 'NY', 'CA', etc."
},
{
"data_type": "text",
Expand Down Expand Up @@ -164,7 +164,7 @@
{
"data_type": "text",
"column_name": "flight_days",
"column_description": "Days of the week the flight operates on. comma-delimited 3-letter abbreviation, eg `mon,tue,wed`"
"column_description": "Days of the week the flight operates on. Formatted as comma-delimited 3-letter abbreviations, e.g. `mon,tue,wed` or `tues,thurs`"
},
{
"data_type": "text",
Expand Down Expand Up @@ -238,7 +238,7 @@
{
"data_type": "text",
"column_name": "time_zone_code",
"column_description": "The code assigned to the time zone where the airport is located."
"column_description": "The code assigned to the time zone where the airport is located. Either 'EST', 'CST', 'MST', or 'PST'."
},
{
"data_type": "text",
Expand Down Expand Up @@ -305,12 +305,12 @@
{
"data_type": "text",
"column_name": "basic_type",
"column_description": "The basic type of the aircraft."
"column_description": "The basic type of the aircraft. Only 'Jet' is a possible value."
},
{
"data_type": "text",
"column_name": "propulsion",
"column_description": "The type of propulsion used by the aircraft."
"column_description": "The type of propulsion used by the aircraft. Only 'Jet' is a possible value."
},
{
"data_type": "text",
Expand All @@ -332,7 +332,7 @@
{
"data_type": "text",
"column_name": "time_zone_code",
"column_description": "A short code that represents the time zone"
"column_description": "A short code that represents the time zone. For example, 'EST', 'CST', 'MST', or 'PST'."
},
{
"data_type": "text",
Expand All @@ -349,12 +349,12 @@
{
"data_type": "text",
"column_name": "booking_class",
"column_description": "The booking class associated with the fare basis"
"column_description": "The booking class associated with the fare basis. Either 'First', 'Business', or 'Economy'"
},
{
"data_type": "text",
"column_name": "class_type",
"column_description": "The class type associated with the fare basis"
"column_description": "The class type associated with the fare basis. Either 'First Class', 'Business Class', or 'Economy Class'"
},
{
"data_type": "text",
Expand All @@ -379,7 +379,7 @@
{
"data_type": "text",
"column_name": "season",
"column_description": "The season associated with the fare basis"
"column_description": "The season associated with the fare basis. Can only be 'Peak' or 'Regular'"
},
{
"data_type": "text",
Expand Down Expand Up @@ -492,7 +492,7 @@
{
"data_type": "text",
"column_name": "application",
"column_description": "The type of fare application, such as one-way or round-trip."
"column_description": "The type of fare application. Either 'One Way' or 'Round Trip'."
},
{
"data_type": "text",
Expand All @@ -502,7 +502,7 @@
{
"data_type": "text",
"column_name": "no_discounts",
"column_description": "Indicates whether the fare is eligible for discounts or promotions."
"column_description": "Indicates whether the fare is eligible for discounts or promotions. Either 'Yes' or 'No'."
},
{
"data_type": "text",
Expand All @@ -512,7 +512,7 @@
{
"data_type": "text",
"column_name": "saturday_stay_required",
"column_description": "Indicates whether a Saturday night stay is required for the fare."
"column_description": "Indicates whether a Saturday night stay is required for the fare. Either 'Yes' or 'No'."
}
],
"dual_carrier": [
Expand Down Expand Up @@ -627,7 +627,7 @@
{
"data_type": "text",
"column_name": "direction",
"column_description": "The direction of the airport from the city"
"column_description": "The direction of the airport from the city. Either 'North', 'South', 'East', 'West', 'Northeast', 'Northwest', 'Southeast', or 'Southwest'."
}
],
"class_of_service": [
Expand Down Expand Up @@ -663,12 +663,12 @@
{
"data_type": "text",
"column_name": "compartment",
"column_description": "The compartment column contains the name of a compartment."
"column_description": "The compartment column contains the name of a compartment. Either 'First', 'Business', or 'Economy'."
},
{
"data_type": "text",
"column_name": "class_type",
"column_description": "The class_type column contains the type of a class."
"column_description": "The class_type column contains the type of a class. Either 'First Class', 'Business Class', or 'Economy Class'."
}
],
"equipment_sequence": [
Expand Down
4 changes: 2 additions & 2 deletions defog_data/atis/atis.sql
View file
Original file line number Diff line number Diff line change
Expand Up @@ -278,8 +278,8 @@ INSERT INTO public.airport_service (city_code, airport_code, miles_distant, dire
('NYC', 'JFK', 60, 'Northwest', 120),
('NYC', 'JFK', 70, 'Southeast', 140),
('NYC', 'JFK', 80, 'Southwest', 160),
('NYC', 'JFK', 90, 'Up', 180),
('NYC', 'JFK', 100, 'Down', 200),
('NYC', 'JFK', 90, 'North', 180),
('NYC', 'JFK', 100, 'South', 200),
('LA', 'LAX', 15, 'West', 30),
('LA', 'LAX', 25, 'East', 50),
('DA', 'DAL Love Field', 5, 'North', 10),
Expand Down
4 changes: 2 additions & 2 deletions defog_data/geography/geography.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
{
"data_type": "text",
"column_name": "traverse",
"column_description": "The cities or landmarks the river passes through. Comma delimited, eg `new york,albany,boston`"
"column_description": "The cities or landmarks the river passes through. Comma delimited and in title case, eg `New York,Albany,Boston`"
}
],
"state": [
Expand Down Expand Up @@ -117,7 +117,7 @@
{
"data_type": "text",
"column_name": "highest_point",
"column_description": "The highest point in the state"
"column_description": "The highest point in the state. If unknown, use 'Unnamed location'."
},
{
"data_type": "text",
Expand Down
14 changes: 7 additions & 7 deletions defog_data/yelp/yelp.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
{
"column_name": "month",
"data_type": "text",
"column_description": "Month when the tip was created"
"column_description": "Month when the tip was created. Eg. 'January', 'February', etc."
},
{
"column_name": "user_id",
Expand All @@ -24,12 +24,12 @@
{
"column_name": "business_id",
"data_type": "text",
"column_description": "Unique identifier for the business where the tip was created"
"column_description": "Unique identifier for the business where the tip was created."
},
{
"column_name": "text",
"data_type": "text",
"column_description": "Text content of the tip"
"column_description": "Text content of the tip. All apostrophes use ’ instead of ' to avoid SQL errors."
}
],
"users": [
Expand Down Expand Up @@ -68,12 +68,12 @@
{
"data_type": "text",
"column_name": "month",
"column_description": "The month in which the review was posted."
"column_description": "The month in which the review was posted. Eg. 'January', 'February', etc."
},
{
"data_type": "text",
"column_name": "text",
"column_description": "The text of the review."
"column_description": "The text of the review. All apostrophes use ’ instead of ' to avoid SQL errors."
},
{
"data_type": "text",
Expand Down Expand Up @@ -105,7 +105,7 @@
{
"data_type": "text",
"column_name": "day",
"column_description": "Day of the week when the check-ins occurred"
"column_description": "Day of the week when the check-ins occurred. Eg. 'Monday', 'Tuesday', etc."
}
],
"business": [
Expand Down Expand Up @@ -152,7 +152,7 @@
{
"data_type": "text",
"column_name": "name",
"column_description": "The name of the business"
"column_description": "The name of the business. All apostrophes use ’ instead of ' to avoid SQL errors."
},
{
"data_type": "text",
Expand Down

0 comments on commit 707df36

Please sign in to comment.