From a5593c42e0b6d37caed49667197c0060cd9169c2 Mon Sep 17 00:00:00 2001 From: Satwik Date: Thu, 31 Oct 2019 00:59:57 +0530 Subject: [PATCH] Update comments --- irrelevant/json_generator.py | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/irrelevant/json_generator.py b/irrelevant/json_generator.py index cfebf4f..11eab86 100644 --- a/irrelevant/json_generator.py +++ b/irrelevant/json_generator.py @@ -2,12 +2,19 @@ An inefficient monolithic piece of code that'll generate jupyter notebook from the projects main README. -TODO +PS: If you are a recruiter, please don't judge me by this piece of code. I wrote it +in hurry. I know this is messy and can be simplified, but I don't want to change it +much because it just works. -- CLI arguments for running this thing. +Simplifictions and improvements through patches are more than welcome however :) + + +#TODOs + +- CLI arguments for running this thing - Add it to prepush hook +- Add support for skip comments, to skip examples that are not meant for notebook environment. - Use templates? - """ import json