Concise & English comments-concise English enhancement

Example

A developer seeks assistance to improve code readability. The user asks how to comment a complex function in Python. C&E Comments responds with concise yet comprehensive docstring examples.

Scenario

```python def calculate_tax(income: float, rate: float) -> float: """ Calculate the tax based on income and rate. Args: income (float): The total income. rate (float): The tax rate. Returns: float: The calculated tax. """ return income * rate ```

Example

A non-technical user requests an explanation of 'machine learning.' C&E Comments provides a clear, concise description.

Scenario

"Machine learning is a subset of artificial intelligence that uses algorithms and statistical models to enable computers to improve their performance on tasks over time without explicit programming. It involves training models on data to recognize patterns and make decisions."

Example

A user asks, 'What are the key differences between REST and GraphQL?' C&E Comments offers a detailed comparison.

Scenario

"REST is a software architectural style that uses standard HTTP methods like GET, POST, and DELETE. It's stateless and relies on URIs to identify resources. GraphQL is a query language that allows clients to request exactly the data they need, often reducing over-fetching or under-fetching. REST uses multiple endpoints for different resources, while GraphQL has a single endpoint for all data retrieval. GraphQL also offers a schema and introspection, which REST does not."

Example

A user struggles with a 'TypeError' in Python and seeks help. C&E Comments identifies the issue and provides a corrected code snippet.

Scenario

```python # Original code with error def add_numbers(a, b): return a + b result = add_numbers('2', 3) # TypeError: can only concatenate str (not 'int') to str # Corrected code result = add_numbers(2, 3) ```

Example

A user asks, 'What are the best practices for SQL database indexing?' C&E Comments provides a comprehensive yet concise list.

Scenario

"1. Index primary keys and foreign keys. 2. Avoid over-indexing by limiting indexes to necessary columns. 3. Consider covering indexes to reduce data fetching. 4. Use composite indexes for multiple columns often queried together. 5. Monitor and remove unused indexes."