summaryrefslogtreecommitdiffstats
path: root/docs/guides/help_me.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides/help_me.md')
-rw-r--r--docs/guides/help_me.md106
1 files changed, 106 insertions, 0 deletions
diff --git a/docs/guides/help_me.md b/docs/guides/help_me.md
new file mode 100644
index 00000000..1a56a74a
--- /dev/null
+++ b/docs/guides/help_me.md
@@ -0,0 +1,106 @@
+### Guide: How can AI help me with writing code?
+
+🤖 Ever dreamt of writing code at lightning speed, effortlessly crafting clean, bug-free functionalities? Welcome to the age of AI-powered coding, where your imagination merges seamlessly with the machine's precision. This guide unveils 4 powerful ways AI can become your secret weapon in the coding world, saving you time, resources, and frustration. 😎
+
+- Language Agnostic? No Problem! Rewrite Code with Ease
+- Improving Written Code: Polish Your Code Like a Pro
+- Demystifying the Unreadable: Deobfuscating Unreadable Code
+- Custom Functions: Your AI-Powered Genie in a Bottle
+
+So you can streamline your coding process, improve code quality, and enhance productivity.
+
+#### 1. Rewriting Code from One Language to Another
+You can leverage AI to translate code from one programming language to another. For instance, you can easily convert JavaScript code to Python using the following approach:
+
+**Prompt:**
+```
+Rewrite this JavaScript code to Python code. Use the aiohttp package:
+```
+```javascript
+async function fetch_data(url) {
+ const response = await fetch(url);
+ const data = await response.json();
+ return data;
+}
+```
+
+**AI Response:**
+```python
+import aiohttp
+
+async def fetch_data(url):
+ async with aiohttp.ClientSession() as session:
+ async with session.get(url) as response:
+ data = await response.json()
+ return data
+```
+
+#### 2. Improving Written Code
+You can ask the AI to enhance your code by adding comments, docstrings, and type hints for better readability and maintainability.
+
+**Example Usage:**
+```
+Improve this Python code, add Google docstrings and type hints.
+Responses with the complete code and don't use placeholders.
+Keep the comments:
+```
+```python
+def calculate_area(radius):
+ # Calculate the area of a circle
+ return 3.14 * radius ** 2
+```
+
+**AI Response:**
+```python
+def calculate_area(radius: float) -> float:
+ """Calculate the area of a circle.
+
+ Args:
+ radius (float): The radius of the circle.
+
+ Returns:
+ float: The area of the circle.
+ """
+ return 3.14 * radius ** 2
+```
+
+#### 3. Deobfuscating Unreadable Code
+AI can help in making obfuscated or unreadable code more understandable and maintainable.
+
+**Example Usage:**
+```
+Deobfuscate this JavaScript code. Improve the readability:
+```
+
+```javascript
+(function() {
+ var a = 'Hello', b = 'World';
+ console.log(a + ' ' + b);
+})();
+```
+
+**AI Response:**
+```javascript
+(function() {
+ var greeting = 'Hello';
+ var subject = 'World';
+ console.log(greeting + ' ' + subject);
+})();
+```
+
+#### 4. Writing Custom Functions
+You can also ask the AI to generate custom functions or help you with specific coding issues.
+
+**Example Usage:**
+```
+Write a function that returns the sum of two numbers.
+```
+
+**AI Response:**
+```python
+def add_numbers(a, b):
+ """Add two numbers together."""
+ return a + b
+```
+
+These are just a few ways AI can revolutionize your coding experience. As AI technology continues to evolve, the possibilities are endless. So, embrace the future, unlock the power of AI, and watch your coding potential soar! 👷‍♂️ \ No newline at end of file