Skip to content

Commit 7215949

Browse files
committed
Remove emoji slop from public-facing documentation
Clean up documentation for professional appearance by removing all emojis from README and tutorial files: - README.md: Remove emojis from section headers and bullet points - docs/tutorials/getting_started.md: Remove emojis from all print statements and code output formatting - docs/tutorials/caching_data.md: Remove emoji from summary section - docs/tutorials/working_with_geometry.md: Remove emoji from summary section Emojis are a tell-tale sign of AI-assisted writing and detract from professional technical documentation.
1 parent 0682c70 commit 7215949

4 files changed

Lines changed: 40 additions & 40 deletions

File tree

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,35 +10,35 @@ Access, retrieve, and work with Canadian Census data and geography.
1010

1111
**pycancensus** is a Python package that provides integrated, convenient, and uniform access to Canadian Census data and geography retrieved using the CensusMapper API. This package produces analysis-ready tidy DataFrames and spatial data in multiple formats, with full equivalence to the R cancensus library.
1212

13-
## 🚀 **Recent Updates**
13+
## Recent Updates
1414

15-
**Full R Library Equivalence** - Verified 100% data compatibility with R cancensus
16-
**Enhanced API Reliability** - Production-grade error handling and retry logic
17-
**Vector Hierarchy Functions** - Navigate census variable relationships like R
18-
**Improved Data Quality** - Fixed column naming and data processing issues
19-
**Comprehensive Testing** - 450+ integration tests covering real-world scenarios
15+
**Full R Library Equivalence** - Verified 100% data compatibility with R cancensus
16+
**Enhanced API Reliability** - Production-grade error handling and retry logic
17+
**Vector Hierarchy Functions** - Navigate census variable relationships like R
18+
**Improved Data Quality** - Fixed column naming and data processing issues
19+
**Comprehensive Testing** - 450+ integration tests covering real-world scenarios
2020

2121
## Features
2222

23-
### 📊 **Data Access**
23+
### Data Access
2424
* Download Census data and geography in analysis-ready format
2525
* Support for multiple Census years: 2021, 2016, 2011, 2006, 2001, 1996
2626
* All Census geographic levels: PR, CMA, CD, CSD, CT, DA, EA, DB
2727
* Taxfiler data at Census Tract level (2000-2018)
2828

29-
### 🔍 **Variable Discovery**
30-
* **`list_census_vectors()`** - Browse all available variables
31-
* **`search_census_vectors()`** - Search variables by keyword
32-
* **`parent_census_vectors()`** - Navigate variable hierarchies upward
33-
* **`child_census_vectors()`** - Navigate variable hierarchies downward
34-
* **`find_census_vectors()`** - Enhanced variable search with fuzzy matching
29+
### Variable Discovery
30+
* `list_census_vectors()` - Browse all available variables
31+
* `search_census_vectors()` - Search variables by keyword
32+
* `parent_census_vectors()` - Navigate variable hierarchies upward
33+
* `child_census_vectors()` - Navigate variable hierarchies downward
34+
* `find_census_vectors()` - Enhanced variable search with fuzzy matching
3535

36-
### 🗺️ **Geographic Capabilities**
36+
### Geographic Capabilities
3737
* GeoPandas integration for spatial analysis
3838
* Multiple resolution options (simplified/high)
3939
* Seamless geometry + data integration
4040

41-
### 🛡️ **Reliability & Performance**
41+
### Reliability & Performance
4242
* Production-grade error handling with helpful messages
4343
* Automatic retry logic with exponential backoff
4444
* Connection pooling for improved performance
@@ -119,7 +119,7 @@ data_2021 = pc.get_census("CA21", {"CSD": "5915022"}, ["v_CA21_1"], "CSD")
119119
data_2016 = pc.get_census("CA16", {"CSD": "5915022"}, ["v_CA16_401"], "CSD")
120120
```
121121

122-
## 🔍 **Variable Discovery Examples**
122+
## Variable Discovery Examples
123123

124124
```python
125125
# Search for housing-related variables
@@ -134,7 +134,7 @@ parent_categories = pc.parent_census_vectors(population_base, dataset="CA21")
134134
income_vectors = pc.find_census_vectors("CA21", "median household income")
135135
```
136136

137-
## 🛡️ **Error Handling & Resilience**
137+
## Error Handling & Resilience
138138

139139
pycancensus includes production-grade error handling:
140140

@@ -151,7 +151,7 @@ except CensusAPIError as e:
151151
print(f"Suggestion: {e.suggestion}")
152152
```
153153

154-
## 🧪 **Testing & Verification**
154+
## Testing & Verification
155155

156156
pycancensus includes comprehensive testing to ensure reliability and R equivalence:
157157

docs/tutorials/caching_data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -485,7 +485,7 @@ monitor.get_stats()
485485

486486
This tutorial covered comprehensive cache management for pycancensus:
487487

488-
**Key Concepts Learned:**
488+
**Key Concepts Learned:**
489489
- How pycancensus caching works automatically
490490
- Configuring cache location and settings
491491
- Measuring cache performance improvements

docs/tutorials/getting_started.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ kernelspec:
1616
This tutorial demonstrates the enhanced pycancensus functionality with clear hierarchy examples and real data access.
1717

1818
## Key Features Demonstrated:
19-
- 📊 **list_census_vectors()** - Browse all available data variables
20-
- 🌳 **Vector Hierarchies** - Navigate parent-child relationships
21-
- 🔍 **find_census_vectors()** - Smart search functionality
22-
- 📈 **Real Data Retrieval** - Get actual census data
19+
- **list_census_vectors()** - Browse all available data variables
20+
- **Vector Hierarchies** - Navigate parent-child relationships
21+
- **find_census_vectors()** - Smart search functionality
22+
- **Real Data Retrieval** - Get actual census data
2323

2424
```{note}
2525
You'll need a free API key from [CensusMapper](https://censusmapper.ca/users/sign_up) to run these examples with real data.
@@ -43,7 +43,7 @@ import pandas as pd
4343
4444
# Set your API key (replace with your actual key)
4545
# pycancensus.set_api_key("your_api_key_here")
46-
print("pycancensus imported successfully!")
46+
print("pycancensus imported successfully!")
4747
```
4848

4949
## 1. Exploring Census Vectors
@@ -54,12 +54,12 @@ The `list_census_vectors()` function shows all available data variables:
5454
# List all vectors for 2021 Census
5555
try:
5656
vectors_ca21 = list_census_vectors('CA21')
57-
print(f"📊 CA21 Census has {len(vectors_ca21):,} vectors available")
58-
print(f"📋 Columns: {list(vectors_ca21.columns)}")
59-
57+
print(f"CA21 Census has {len(vectors_ca21):,} vectors available")
58+
print(f"Columns: {list(vectors_ca21.columns)}")
59+
6060
# Show how many vectors have parent relationships
6161
with_parents = vectors_ca21[vectors_ca21['parent_vector'].notna()]
62-
print(f"🔗 Vectors with parent relationships: {len(with_parents):,} out of {len(vectors_ca21):,}")
62+
print(f"Vectors with parent relationships: {len(with_parents):,} out of {len(vectors_ca21):,}")
6363
print("\nSample hierarchy examples:")
6464
display(with_parents[['vector', 'parent_vector', 'label']].head())
6565
@@ -80,9 +80,9 @@ try:
8080
# Get the vector details for context
8181
income_info = vectors_ca21[vectors_ca21['vector'] == income_root]
8282
if not income_info.empty:
83-
print(f"🌳 Household Income Hierarchy\n")
84-
print(f"📊 ROOT: {income_root} - {income_info['label'].iloc[0][:50]}...")
85-
print(f"\n📊 LEVEL 1 - Income Brackets:")
83+
print(f"Household Income Hierarchy\n")
84+
print(f"ROOT: {income_root} - {income_info['label'].iloc[0][:50]}...")
85+
print(f"\nLEVEL 1 - Income Brackets:")
8686
8787
# Get its direct children (income brackets)
8888
income_children = child_census_vectors(income_root, 'CA21')
@@ -98,16 +98,16 @@ except Exception as e:
9898
try:
9999
# Drill down into the high-income bracket (shows grandparent -> parent -> child)
100100
high_income_bracket = "v_CA21_939" # $100,000 and over
101-
print(f"📊 LEVEL 2 - High-income sub-categories for '{high_income_bracket}':")
102-
101+
print(f"LEVEL 2 - High-income sub-categories for '{high_income_bracket}':")
102+
103103
# Get the children of the $100,000+ bracket
104104
high_income_subcats = child_census_vectors(high_income_bracket, 'CA21')
105105
display(high_income_subcats[['vector', 'label', 'parent_vector']])
106-
106+
107107
# Show the parent relationship for context
108108
parent_info = parent_census_vectors(high_income_bracket, 'CA21')
109109
if not parent_info.empty:
110-
print(f"\n⬆️ Parent of this bracket: {parent_info['vector'].iloc[0]} - {parent_info['label'].iloc[0][:50]}...")
110+
print(f"\nParent of this bracket: {parent_info['vector'].iloc[0]} - {parent_info['label'].iloc[0][:50]}...")
111111
112112
except Exception as e:
113113
print(f"Error exploring detailed hierarchy: {e}")
@@ -122,7 +122,7 @@ try:
122122
# Find parent of a specific income bracket
123123
income_bracket = "v_CA21_942" # $150,000 to $199,999
124124
parent = parent_census_vectors(income_bracket, 'CA21')
125-
print(f"⬆️ Finding parent of income bracket '{income_bracket}':")
125+
print(f"Finding parent of income bracket '{income_bracket}':")
126126
display(parent[['vector', 'label', 'parent_vector']])
127127
128128
except Exception as e:
@@ -137,7 +137,7 @@ The `find_census_vectors()` function provides smart search with relevance scorin
137137
try:
138138
# Search for income-related vectors
139139
income_vectors = find_census_vectors('CA21', 'income')
140-
print(f"🔍 Found {len(income_vectors)} income-related vectors")
140+
print(f"Found {len(income_vectors)} income-related vectors")
141141
print(f"\nTop income vectors (sorted by relevance):")
142142
display(income_vectors[['vector', 'label', 'relevance_score']].head(3))
143143
@@ -160,7 +160,7 @@ try:
160160
use_cache=False
161161
)
162162
163-
print(f"📈 Toronto CMA Income Demographics:")
163+
print(f"Toronto CMA Income Demographics:")
164164
print(f"\nHousehold Income Distribution:")
165165
total_households = toronto_data['v_CA21_923'].iloc[0]
166166
high_income = toronto_data['v_CA21_939'].iloc[0] # $100,000+
@@ -179,7 +179,7 @@ except Exception as e:
179179

180180
## Summary
181181

182-
**This tutorial demonstrates the enhanced pycancensus capabilities:**
182+
**This tutorial demonstrates the enhanced pycancensus capabilities:**
183183

184184
1. **list_census_vectors()** - Browse 7,709+ available variables with explicit parent-child relationships
185185
2. **Hierarchy Navigation** - Navigate through income hierarchies from main categories to detailed brackets

docs/tutorials/working_with_geometry.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,7 @@ print(f"Average income: ${vancouver_data['v_CA21_434'].mean():,.0f}")
398398

399399
This tutorial covered the essential aspects of working with geographic census data:
400400

401-
**Key Skills Learned:**
401+
**Key Skills Learned:**
402402
- Retrieving census data with geographic boundaries
403403
- Understanding Canadian census geographic levels
404404
- Creating choropleth maps with matplotlib

0 commit comments

Comments
 (0)