Merge pull request #45 from UBC-MDS/ml4_change_log

fix: changed `fml` to `fml_doc_gen` in all files for consistency
UBC-MDS · Jan 31, 2025 · 9c1a818 · 9c1a818
2 parents f292cf8 + 189e81b
commit 9c1a818
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -40,10 +40,10 @@ If you are proposing a feature:
 
 ## Get Started!
 
-Ready to contribute? Here's how to set up `fml` for local development.
+Ready to contribute? Here's how to set up `fml_doc_gen` for local development.
 
-1. Download a copy of `fml` locally.
-2. Install `fml` using `poetry`:
+1. Download a copy of `fml_doc_gen` locally.
+2. Install `fml_doc_gen` using `poetry`:
 
     ```console
     $ poetry install
@@ -69,5 +69,5 @@ Before you submit a pull request, check that it meets these guidelines:
 
 ## Code of Conduct
 
-Please note that the `fml` project is released with a
+Please note that the `fml_doc_gen` project is released with a
 Code of Conduct. By contributing to this project you agree to abide by its terms.
diff --git a/docs/conf.py b/docs/conf.py
@@ -6,7 +6,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = u"fml"
+project = u"fml_doc_gen"
 copyright = u"2025, Farhan Faisal, Michael Suriawan, Lukman Lateef"
 author = u"Farhan Faisal, Michael Suriawan, Lukman Lateef"
 

diff --git a/docs/example.ipynb b/docs/example.ipynb
@@ -267,12 +267,12 @@
             ]
         },
         {
-            "cell_type": "code",
-            "execution_count": 5,
+            "cell_type": "markdown",
             "metadata": {},
-            "outputs": [],
             "source": [
-                "documentation = generate_docstring_template(square, output_file=None, auto_generate=True)"
+                "```\n",
+                "documentation = generate_docstring_template(square, output_file=None, auto_generate=True)\n",
+                "```"
             ]
         },
         {