[Hacktoberfest Challenge] Write the docs ✏️

[ghostinhershell]

Documentation is one of the most hauntingly valuable and desperately needed contributions in open source, don't let it become a ghost town! Explaining how something works, should be used, or what spine-tingling considerations to watch out for helps everyone better use the project without stumbling into dark corners.

This week, we've conjured up some practice to help you get in the groove of writing how things work. Dare to take on this week's challenge... if you're brave enough! 🎃

Challenge 🔨

Pick one of the code functions below and write documentation to go along with it, the documentation can include basic descriptions, parameter explanations, doc strings, and/or return value details.

Java Code

public class SimpleFunctions {

    // Add two numbers and return the result
    public static int addNumbers(int a, int b) {
        return a + b;
    }

    // Check if a number is even
    public static boolean isEven(int number) {
        return number % 2 == 0;
    }

    // Return a greeting message for the given name
    public static String greet(String name) {
        return "Hello, " + name + "!";
    }
}

JavaScript

function addNumbers(a, b) {
  // Add two numbers and return the result
  return a + b;
}

function isEven(number) {
  // Check if a number is even
  return number % 2 === 0;
}

function greet(name) {
  // Return a greeting message for the given name
  return `Hello, ${name}!`;
}

Python Code

	def add_numbers(a, b):
    """Add two numbers and return the result."""
    return a + b

def is_even(number):
    """Check if a number is even."""
    return number % 2 == 0

def greet(name):
    """Return a greeting message for the given name."""
    return f"Hello, {name}!"

Tips ✨

• Documentation done right: A developer’s guide, learn why and how you should write docs for your project with the Diátaxis framework.
• Best practices for GitHub Docs: Follow these best practices to create documentation that's user-friendly and easy to understand.

Inspiration ⚡

Beautiful-Docs repository from @matheusfelipeog, pointers to useful, well-written, and otherwise beautiful documentation, all in real life examples.

Happy documenting!

[tonboy952-glitch]

Thank