About
-About
+TODO
diff --git a/output/assets/styles/style.css b/output/assets/styles/style.css index 6dffb3a..8182c6c 100644 --- a/output/assets/styles/style.css +++ b/output/assets/styles/style.css @@ -176,6 +176,21 @@ footer{ box-sizing: border-box; } +/* Make margin notes stack instead of overlapping */ +.sidenote, +.marginnote{ + display: block; /* spans -> blocks so clearing works predictably */ + clear: right; /* each note starts below the previous right-floated note */ +} + +/* Add a little spacing between consecutive notes in the margin */ +.sidenote + .sidenote, +.sidenote + .marginnote, +.marginnote + .sidenote, +.marginnote + .marginnote{ + margin-top: .4rem; +} + /* Optional: show the same footnote number in the margin */ .footnote-sidenote::before{ content: attr(data-fn) " "; diff --git a/output/blogs/2025/08/benefits-of-reading.html b/output/blogs/2025/08/benefits-of-reading.html index e55a911..dc63175 100644 --- a/output/blogs/2025/08/benefits-of-reading.html +++ b/output/blogs/2025/08/benefits-of-reading.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +Table of Contents
Benefits 1
-Benefits 1
+At times, I find myself being able to digest material more quickly and efficiently, and so I thought to myself as to what the probable cause of this was. The answer transpired to be the inculcating of reading in my daily routine. As humans, we are constantly surrounded with information, some are noisy, some are useful. We can choose to filter out noisy information by limiting exposure of their avenues, however the topic I wanted to briefly touch upon is what are the (cognitive and non-cognitive) benefits of increasing the intake of useful information through the medium of reading?
Mental Stimulation
-Mental Stimulation
+The brain is a muscle, in order to keep any muscle strong and healthy, it needs stimulation and attention. Thus, reading is an excellent way of ensuring the brain is fit and healthy.
Stress Reduction
-Stress Reduction
+A well written novel or informative book can go a long way in making you forget about the worries of the world.
Increase in Knowledge
-Increase in Knowledge
+Reading will always fill your head with new information.
Entertainment
-Entertainment
+A plethora of genres can keep anyone entertained!
Better writing skills
-Better writing skills
+Being exposed to different writing styles allows you to be influenced to obtaining your own unique writing style.
diff --git a/output/blogs/2025/08/hilberts.hotel.html b/output/blogs/2025/08/hilberts.hotel.html index 1f2d854..2ef7546 100644 --- a/output/blogs/2025/08/hilberts.hotel.html +++ b/output/blogs/2025/08/hilberts.hotel.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +09-08-2025: Website Changes
-What was worked on
-What was worked on
+I saw a few websites that used marginal notes on the right side of the screen like this one, so I decided to try and implement this feature in this wesbite. In my mind I thought of using an external pre-configured CSS that I can just insert and ta-da it would work.
diff --git a/output/blogs/2025/08/third-time.html b/output/blogs/2025/08/third-time.html new file mode 100644 index 0000000..a368dae --- /dev/null +++ b/output/blogs/2025/08/third-time.html @@ -0,0 +1,278 @@ + + + + + + + +
+
+
+ Third Time
+ + +Table of Contents
+ +A more structured way of working
++ Useful for people who don't like the constrained working limit of 25 minutes for instance. +
+ +
+Whilst researching for different ways to use pomodoro 1 on Emacs 2, I came across this package titled: pomm.el. In this package it had an interesting feature called pomm-third-time3. The ideology behind is as follows:
+
-
+
- You work as long as you want. +
- Your break is calculated using the formula:
Time of break = 1/3 x Time of work.
+ - If you take a shorter break, the remaining break time is accumulated and added to the next break (within the same session). +
Footnotes:
+ +Wacom With Arch
-Setting up Wacom Tablet in Arch Hyprland
-Setting up Wacom Tablet in Arch Hyprland
+I purchased a One by Wacom tablet almost 2 years ago now and it works flawlessly in both Windows and MacOS and even in most Linux distros with some configuration.
diff --git a/output/blogs/2025/08/weekly-review-week-ending-august-10-2025.html b/output/blogs/2025/08/weekly-review-week-ending-august-10-2025.html index e1d945c..58ef8c4 100644 --- a/output/blogs/2025/08/weekly-review-week-ending-august-10-2025.html +++ b/output/blogs/2025/08/weekly-review-week-ending-august-10-2025.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +Table of Contents
-
-
- Reviewing the week -
- Next week +
- Reviewing the week +
- Next week
-
-
- DONE Read as much of Clean Code as possible -
- TODO Finish another (misc) book -
- DONE Write more (metric unspecified, need to experiment to see what works best) -
- TODO Start the book Dose Effect -
- DONE More leetcode problems to solve (again, metric unspecified) -
- TODO Touch typing: daily practice +
- DONE Read as much of Clean Code as possible +
- TODO Finish another (misc) book +
- DONE Write more (metric unspecified, need to experiment to see what works best) +
- TODO Start the book Dose Effect +
- DONE More leetcode problems to solve (again, metric unspecified) +
- TODO Touch typing: daily practice
Reviewing the week
-Reviewing the week
+
Mostly continuing reading from the book clean code, also setup the ankii cards and this website. The amount of leetcode problems I solved could improve however.
Next week
-Next week
+DONE Read as much of Clean Code as possible
+DONE Read as much of Clean Code as possible
TODO Finish another (misc) book
+TODO Finish another (misc) book
DONE Write more (metric unspecified, need to experiment to see what works best)
+DONE Write more (metric unspecified, need to experiment to see what works best)
TODO Start the book Dose Effect
+TODO Start the book Dose Effect
DONE More leetcode problems to solve (again, metric unspecified)
+DONE More leetcode problems to solve (again, metric unspecified)
TODO Touch typing: daily practice
+TODO Touch typing: daily practice
Table of Contents
-
-
- Previous Week +
- Previous Week
-
-
- DONE Read as much of Clean Code as possible -
- TODO Finish another (misc) book -
- DONE Write more (metric unspecified, need to experiment to see what works best) -
- TODO Start the book Dose Effect -
- DONE More leetcode problems to solve (again, metric unspecified) -
- TODO Touch typing: daily practice +
- DONE Read as much of Clean Code as possible +
- TODO Finish another (misc) book +
- DONE Write more (metric unspecified, need to experiment to see what works best) +
- TODO Start the book Dose Effect +
- DONE More leetcode problems to solve (again, metric unspecified) +
- TODO Touch typing: daily practice
- - Next Week +
- Next Week
Previous Week
-Previous Week
+DONE Read as much of Clean Code as possible
+DONE Read as much of Clean Code as possible
TODO Finish another (misc) book
+TODO Finish another (misc) book
DONE Write more (metric unspecified, need to experiment to see what works best)
+DONE Write more (metric unspecified, need to experiment to see what works best)
TODO Start the book Dose Effect
+TODO Start the book Dose Effect
DONE More leetcode problems to solve (again, metric unspecified)
+DONE More leetcode problems to solve (again, metric unspecified)
TODO Touch typing: daily practice
+TODO Touch typing: daily practice
Next Week
-Next Week
+TODO 3/4 of Clean Code
+TODO 3/4 of Clean Code
TODO More book notes
+TODO More book notes
TODO Touch typing: daily practice
+TODO Touch typing: daily practice
TODO Start the book Dose Effect
+TODO Start the book Dose Effect
Table of Contents
I seem to be spending less time working on technical crafts, primarily due to so many other commitments. Making it a goal to remove distractions and focus more on reading, writing and executing.
-Next Week
-Next Week
+TODO Clean Code Finish
+TODO Clean Code Finish
TODO Eliminate Distractions
+TODO Eliminate Distractions
TODO Fix weekly schedule
+TODO Fix weekly schedule
Zettelkasten Method
-The Zettelkasten Method
-The Zettelkasten Method
+This Zettelkasten method is growing in popularity for taking notes. Ever felt as though there's too much pieces of information but you don't know how to deal with it? This method solves exactly that problem and more. Think of it as forming a second brain, where you can jot down ideas and information whilst simultaneously being able to connect them together.
@@ -246,7 +246,7 @@ There are many personal knowledge management systems' (PKMS) out there that allo -
Blogs Introduction
-Introduction
-Introduction
+In this section you will find posts that are not as structured as the ones found in here. Mainly these will deal with findings, research, assorted writings and random bits and blobs.
diff --git a/output/blogs/blogs-list.html b/output/blogs/blogs-list.html index deae0f2..c898323 100644 --- a/output/blogs/blogs-list.html +++ b/output/blogs/blogs-list.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +Blogs List
See the categories: Categories
-Blogs:
-Blogs:
+-
+
- Third Time 28-08-2025 17:08 insights
- Weekly review: Week ending August 24, 2025 24-08-2025 00:00 weekly-review
- Weekly review: Week ending August 17, 2025 17-08-2025 00:00 weekly-review
- Benefits of Reading 14-08-2025 23:36 reading insights diff --git a/output/categories.html b/output/categories.html index d6604ba..b032a55 100644 --- a/output/categories.html +++ b/output/categories.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +
Categories (Includes both blogs and posts)
-Categories (Includes both blogs and posts)
+- books (5)
- education (1)
- emacs (2) -
- insights (3) +
- insights (4)
- introduction (2)
- maths (1)
- notes (5) diff --git a/output/contact.html b/output/contact.html index 13783c6..12e610e 100644 --- a/output/contact.html +++ b/output/contact.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +
Contact
-Contact Using the Following:
-Contact Using the Following:
+> LinkedIn: LinkedIn
diff --git a/output/index.html b/output/index.html index 8811b55..c7d578f 100644 --- a/output/index.html +++ b/output/index.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +Table of Contents
Welcome! 🌱
-Welcome! 🌱
+
This is a website built using Emacs Org-mode and published using org-publish. The very first iteration of this website used the Angular framework, only after a while I realised (as every Emacs lover does) that I want to make this an Emacs-centric project
How to publish web pages using org-publish
-How to publish web pages using org-publish
+
This website is heavily inspired by some people who have decided to use org-publish as a way to convert org files into html. I came across a few that took the plunge and decided to migrate from platforms like Wordpress and instead opted for a more transparent, text-based workflow.
http://localhost:8000/<
Contact
-Contact
+Feel free to reach out on GitHub: https://github.com/zainezq
diff --git a/output/posts.html b/output/posts.html index b8b8de5..b6ead60 100644 --- a/output/posts.html +++ b/output/posts.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +Posts
-Links
-Links
+Posts Introduction intro
+Posts Introduction intro
Zettelkasten Method education
-Zettelkasten Method education
+diff --git a/output/posts/clean-code/clean-code-chapter-1.html b/output/posts/clean-code/clean-code-chapter-1.html index 16e420c..3aec5f1 100644 --- a/output/posts/clean-code/clean-code-chapter-1.html +++ b/output/posts/clean-code/clean-code-chapter-1.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +
Table of Contents
Link to Chapter 2
-Chapter 1: Clean Code
-Chapter 1: Clean Code
+Referenced Items:
diff --git a/output/posts/clean-code/clean-code-chapter-2.html b/output/posts/clean-code/clean-code-chapter-2.html index bd30845..389c686 100644 --- a/output/posts/clean-code/clean-code-chapter-2.html +++ b/output/posts/clean-code/clean-code-chapter-2.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +Table of Contents
-
-
- Chapter 2: Meaningful Names +
- Chapter 2: Meaningful Names
-
-
- Use intention revealing names: -
- Avoid disinformation -
- Make Meaningful Distinctions -
- Use Pronouncable Names -
- Use Searchable Names -
- Avoid Encodings -
- Avoid Mental Mappings -
- Class Names -
- Method Names -
- Don't be cute/Don't use puns -
- Pick one word per concept -
- Solution Domain Names and Problem Domain Names -
- Add Meaningful Context -
- Don't add gratuitous context +
- Use intention revealing names: +
- Avoid disinformation +
- Make Meaningful Distinctions +
- Use Pronouncable Names +
- Use Searchable Names +
- Avoid Encodings +
- Avoid Mental Mappings +
- Class Names +
- Method Names +
- Don't be cute/Don't use puns +
- Pick one word per concept +
- Solution Domain Names and Problem Domain Names +
- Add Meaningful Context +
- Don't add gratuitous context
Link to Chapter 1 | Link to Chapter 3
-Chapter 2: Meaningful Names
-Chapter 2: Meaningful Names
+Use intention revealing names:
-Use intention revealing names:
+
Names should reveal intent, there is no revelation in naming an integer d, intending it stands for days. Instead, you should use the following names:
d<
Avoid disinformation
-Avoid disinformation
+
Don't postfix the word 'list' to the name 'accounts' unless it's actually a list. This is because the reader will assume the data type of accountsList is indeed a list, instead choose a name like accountsGroup.
Make Meaningful Distinctions
-Make Meaningful Distinctions
+While it is possible to name by being disinformative, it is also possible to name being non informative. Consider:
@@ -302,18 +302,18 @@ Furthermore, noise words are redundant. We should never use the wordvaria
Use Pronouncable Names
-Use Pronouncable Names
+
This is quite straightforward. Do not use a name like genymdhms to refer to generation date, year, month, day, hour, minute,
and second. Instead use generationTimeStamp.
Use Searchable Names
-Use Searchable Names
+In modern IDE's, it is still quite difficult to search for single-lettered variables. The writer states a personal preference of using single-letter names only as local variables and inside short methods. The following principle is given:
@@ -323,42 +323,42 @@ In modern IDE's, it is still quite difficult to search for single-lettered variaAvoid Encodings
-Avoid Encodings
+
Don't prefix variables with letters like m_ as was done in the past. Do not type encode as well, an example of this is: PhoneNumber phoneString; we can see the reader being misled into thinking the phone number is a String.
Avoid Mental Mappings
-Avoid Mental Mappings
+Clarity is king, don't use a name for a variable that only you know what it stands for. For example: using the letter r as the lower-cased version of the url with the host and scheme removed. That's being smart, not professional.
Class Names
-Class Names
+
Classes and objects should have noun or noun phrase names like Customer, WikiPage, Account, and AddressParser. Avoid words like Manager, Processor, Data, or Info in the name of a class. A class name should not be a verb
Method Names
-Method Names
+Methods should have verb or verb phrase names.
Don't be cute/Don't use puns
-Don't be cute/Don't use puns
+Do not use names that are only understandable to people whom you share jokes etc with. Furthermore, do not use colloquialism and slang in names.
@@ -368,17 +368,17 @@ Do not use names that are only understandable to people whom you share jokes etcPick one word per concept
-Pick one word per concept
+If you have multiple choices for naming a concept, use one and stick with it. For instance if your options are fetch, get and retrieve, use one and stick with it throughout.
Solution Domain Names and Problem Domain Names
-Solution Domain Names and Problem Domain Names
+Where possible use solution domain names, as the people that are going to be reading the code are programmers. Therefore, do not shy away from using CS terms, algorithm names, math names and so forth.
@@ -388,17 +388,17 @@ However when it is not possible to use solution domain names (in other words, whAdd Meaningful Context
-Add Meaningful Context
+Enclose names with well-named classes, functions, or namespaces. When all else fails, then prefix with something that provides more context.
Don't add gratuitous context
-Don't add gratuitous context
+Shorter names are better than longer ones, generally. This is so long as the context and intent is clear. Don't add redundant or irrelevant additions to the name in the for the sake of 'context'.
diff --git a/output/posts/clean-code/clean-code-chapter-3.html b/output/posts/clean-code/clean-code-chapter-3.html index 91c25b3..467066e 100644 --- a/output/posts/clean-code/clean-code-chapter-3.html +++ b/output/posts/clean-code/clean-code-chapter-3.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +Table of Contents
-
-
- Chapter 3: Functions +
- Chapter 3: Functions
-
-
- Functions should be small -
- Do One Thing & One Level of Abstraction -
- Switch Statements -
- Use Descriptive Names -
- Function Arguments -
- Have No Side Effects -
- Error Handling +
- Functions should be small +
- Do One Thing & One Level of Abstraction +
- Switch Statements +
- Use Descriptive Names +
- Function Arguments +
- Have No Side Effects +
- Error Handling
Link to Chapter 2 | Link to Chapter 4
-Chapter 3: Functions
-Chapter 3: Functions
+Functions should be small
-Functions should be small
+Functions should be extremely short—ideally just a few lines, so they remain easy to understand and maintain.
@@ -269,9 +269,9 @@ Large functions hide complexity and mix abstraction levels, making errors and duDo One Thing & One Level of Abstraction
-Do One Thing & One Level of Abstraction
+A function should do exactly one conceptual task, and all its statements should exist at the same abstraction level.
@@ -293,9 +293,9 @@ Functions that “do one thing” cannot be logically split into sections such aSwitch Statements
-Switch Statements
+Switch statements naturally violate “do one thing” by handling multiple cases; they also grow in size over time.
@@ -350,9 +350,9 @@ Example:Use Descriptive Names
-Use Descriptive Names
+A function’s name should clearly state its purpose. Long, descriptive names beat short, cryptic ones.
@@ -374,9 +374,9 @@ IDE refactoring tools make renaming safe, encouraging experimentation.Function Arguments
-Function Arguments
+
The ideal number of arguments for a function is zero (niladic). Next comes one (monadic), followed closely by two (dyadic). Three arguments (triadic) should be avoided where possible. More than three (polyadic) requires very special justification—and then shouldn’t be used anyway.
write
Have No Side Effects
-Have No Side Effects
+A function should do only what its name promises. Hidden state changes are misleading and dangerous.
@@ -426,9 +426,9 @@ Functions that modify state and return information often cause confusion and shoError Handling
-Error Handling
+Error handling is a single responsibility—separate it from normal logic to keep both paths clear.
diff --git a/output/posts/clean-code/clean-code-chapter-4.html b/output/posts/clean-code/clean-code-chapter-4.html index a4a21e5..f1c79e9 100644 --- a/output/posts/clean-code/clean-code-chapter-4.html +++ b/output/posts/clean-code/clean-code-chapter-4.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +Table of Contents
-
-
- Chapter 4: Comments +
- Chapter 4: Comments
-
-
- Comments Do Not Make Up for Bad Code -
- Good Comments +
- Comments Do Not Make Up for Bad Code +
- Good Comments
-
-
- Legal Comments -
- Informative Comments -
- Explanation of Intent -
- Clarification -
- Warning of Consequences -
- TODO Comments -
- Amplification -
- Javadocs in Public APIs +
- Legal Comments +
- Informative Comments +
- Explanation of Intent +
- Clarification +
- Warning of Consequences +
- TODO Comments +
- Amplification +
- Javadocs in Public APIs
- - Bad Comments +
- Bad Comments
-
-
- Don’t Use a Comment When You Can Use a Function or Variable -
- Position Markers -
- Closing Brace Comments -
- Attributions and Bylines -
- Commented Out Code -
- HTML Comments -
- Nonlocal Information -
- Too Much Information -
- Inobvious Connection -
- Function Headers -
- Javadocs in Nonpublic Code +
- Don’t Use a Comment When You Can Use a Function or Variable +
- Position Markers +
- Closing Brace Comments +
- Attributions and Bylines +
- Commented Out Code +
- HTML Comments +
- Nonlocal Information +
- Too Much Information +
- Inobvious Connection +
- Function Headers +
- Javadocs in Nonpublic Code
Link to Chapter 3 | Link to Chapter 5
--Chapter 4: Comments
-++Chapter 4: Comments
+-Comments are a necessary evil—they exist because code fails to express intent clearly.
@@ -281,9 +281,9 @@ Strive to write code that explains itself; comments should be minimised. Truth is always in the code, not in the comments.-Comments Do Not Make Up for Bad Code
-+-+Comments Do Not Make Up for Bad Code
+Don’t use comments to excuse messy, unclear code. Clean the code instead.
@@ -304,16 +304,16 @@ Clear, expressive code with few comments > cluttered code with many comments.-Good Comments
-++Good Comments
+-Only write them when unavoidable. Such as in the following instances:
-Legal Comments
-++-Legal Comments
+Sometimes required for copyright/licensing.
@@ -323,9 +323,9 @@ Keep them short; refer to standard licenses rather than embedding full legal tex-Informative Comments
-+-+Informative Comments
+Explain return values, formats, or patterns.
@@ -343,9 +343,9 @@ Prefer naming/structuring code to make such comments unnecessary.-Explanation of Intent
-+-+Explanation of Intent
+Describe why a certain approach was chosen.
@@ -371,9 +371,9 @@ Helps future maintainers understand reasoning behind code.-Clarification
-++-Clarification
+Translate obscure values into readable terms.
@@ -383,9 +383,9 @@ Useful when working with unchangeable APIs/libraries, but risky if incorrect.-Warning of Consequences
-++-Warning of Consequences
+Alert others about performance, thread-safety, or side effects.
@@ -399,9 +399,9 @@ For example, in code you can say:-TODO Comments
-++-TODO Comments
+Mark incomplete work or planned improvements.
@@ -411,9 +411,9 @@ Should be reviewed regularly; not an excuse for bad code.-Amplification
-++-Amplification
+Highlight the importance of seemingly small details.
@@ -423,9 +423,9 @@ Highlight the importance of seemingly small details.-Javadocs in Public APIs
-+-+Javadocs in Public APIs
+Public APIs should have clear documentation.
@@ -436,9 +436,9 @@ Javadocs can also mislead. Keep them accurate and up-to-date.-Bad Comments
-++Bad Comments
+-- Don't place a comment just because you feel like it.
- Remove redundant comments. @@ -448,9 +448,9 @@ Javadocs can also mislead. Keep them accurate and up-to-date.
- Remove noise comments.
-Don’t Use a Comment When You Can Use a Function or Variable
-++-Don’t Use a Comment When You Can Use a Function or Variable
+Replace explanatory comments with expressive variable or function names.
@@ -460,9 +460,9 @@ Refactor code to remove comment redundancy.-Position Markers
-++-Position Markers
+Avoid decorative banners like
@@ -476,9 +476,9 @@ Overuse makes them blend into background noise.// Actions ///////////////////////, they add clutter.-Closing Brace Comments
-++-Closing Brace Comments
+Comments on closing braces (} // while) are unnecessary for small, well structured functions.
@@ -488,9 +488,9 @@ Prefer short, clear functions over brace markers.-Attributions and Bylines
-++-Attributions and Bylines
+Don’t add personal tags like
@@ -500,9 +500,9 @@ Such comments become outdated and irrelevant over time./* Added by Rick */, use version control for authorship history.-Commented Out Code
-+-+Commented Out Code
+Never keep old code commented out; delete it and rely on version control history.
@@ -521,9 +521,9 @@ Commented-out code adds clutter and confuses future maintainers.-HTML Comments
-++-HTML Comments
+Avoid HTML markup inside code comments, it makes them harder to read in the editor.
@@ -533,9 +533,9 @@ Let documentation tools (like Javadoc) handle formatting.-Nonlocal Information
-++-Nonlocal Information
+Comments should describe nearby code only, not unrelated parts of the system.
@@ -545,9 +545,9 @@ Avoid embedding global/system details that the function can’t control.-Too Much Information
-++-Too Much Information
+Avoid long, unnecessary historical or technical explanations.
@@ -557,9 +557,9 @@ Keep only relevant context (e.g., “RFC 2045” reference is fine, not the full-Inobvious Connection
-+-+Inobvious Connection
+Ensure the relationship between comment and code is clear.
@@ -577,9 +577,9 @@ Don’t make readers guess what part of the code the comment refers to.-Function Headers
-++-Function Headers
+Short, single purpose functions with good names don’t need header comments.
@@ -589,9 +589,9 @@ Let the function name explain the purpose.-Javadocs in Nonpublic Code
-++Javadocs in Nonpublic Code
+Javadocs are useful for public APIs, but excessive formality in internal code is just noise.
diff --git a/output/posts/clean-code/clean-code-chapter-5.html b/output/posts/clean-code/clean-code-chapter-5.html index 171c746..497d94d 100644 --- a/output/posts/clean-code/clean-code-chapter-5.html +++ b/output/posts/clean-code/clean-code-chapter-5.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +Clean Code: Chapter 5 Notes @@ -224,27 +224,27 @@Table of Contents
-
-
- Chapter 5: Formatting +
- Chapter 5: Formatting
Link to Chapter 4 | Link to Chapter 6
--Chapter 5: Formatting
-++Chapter 5: Formatting
+--Vertical Formatting
-++Vertical Formatting
+-- Vertical openness (blank lines) separates concepts and improves readability.
- Too much density makes code look like a muddle and harder to scan.
-Vertical Density
-++Vertical Density
+- Tightly related lines should appear vertically dense.
- Avoid useless comments that interrupt association. @@ -293,9 +293,9 @@ Link to Chapter 4 | Link to -
- Related concepts should be kept close together to reduce scrolling and searching.
- Local variables → as close to use as possible, usually at top of function. @@ -325,9 +325,9 @@ Link to Chapter 4 | Link to -
- Group functions with similar naming or shared purpose.
- Example (JUnit assert methods): @@ -341,9 +341,9 @@ Link to Chapter 4 | Link to -
- Organise code top down:
-
@@ -355,9 +355,9 @@ Link to Chapter 4 | Link to
-
- Use vertical openness to separate concepts.
- Use vertical density to group related ones. @@ -367,9 +367,9 @@ Link to Chapter 4 | Link to -
- Clean Code: Chapter 5 Notes 28-08-2025 17:03 books notes
- Clean Code: Chapter 4 Notes 28-08-2025 16:38 books notes diff --git a/output/setup.html b/output/setup.html index f0e20ad..65337c6 100644 --- a/output/setup.html +++ b/output/setup.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +
- Tag: education
- Tag: reading
- Tag: review -
- Tag: insights
- Tag: website
- Tag: maths +
- Tag: insights
- Tag: weekly-review diff --git a/output/tags/books.html b/output/tags/books.html index 80025fb..4f4581d 100644 --- a/output/tags/books.html +++ b/output/tags/books.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +
Summary - vertical
-++Summary - vertical
+Horizontal Formatting
-++-Horizontal Formatting
+Keep lines short. Most professional code naturally stays within ~45 characters, with ~80 as an upper bound. Lines beyond 100–120 characters are generally careless.
@@ -391,9 +391,9 @@ Example limit guideline:-Horizontal Openness and Density
-++-Horizontal Openness and Density
+Use spaces to separate low-precedence operators (e.g., +, -, =) and improve readability.
@@ -416,9 +416,9 @@ Separate arguments with spaces after commas to show distinct parameters.-Horizontal Alignment
-+-+Horizontal Alignment
+Avoid aligning variable declarations or assignments in columns, it draws the eye to the wrong place.
@@ -446,9 +446,9 @@ Example (preferred unaligned):-Indentation
-++-Indentation
+Indent according to scope hierarchy:
@@ -478,9 +478,9 @@ Avoid collapsing scopes onto one line, always use braces and proper indenting.-Dummy Scopes
-+-+Dummy Scopes
+Avoid dummy bodies in loops (e.g., empty while or for loops).
@@ -497,9 +497,9 @@ If unavoidable, place semicolon on its own indented line to make it visible.-Team Rules
-++-Team Rules
+Teams must agree on a single formatting style for consistency.
@@ -513,9 +513,9 @@ Consistent formatting builds trust and reduces mental load for readers.-Uncle Bob’s Formatting Rules (Example in CodeAnalyzer.java)
-++Uncle Bob’s Formatting Rules (Example in CodeAnalyzer.java)
+Short, clear methods with consistent spacing and indentation.
diff --git a/output/posts/posts-intro.html b/output/posts/posts-intro.html index cba672e..245f36c 100644 --- a/output/posts/posts-intro.html +++ b/output/posts/posts-intro.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +Posts Introduction @@ -220,9 +220,9 @@Posts Introduction
--Introduction
-++Introduction
+-In this section you will find posts related to both technical and non-technical topics. As Einstein said: “If you can’t explain it simply you don’t understand it well enough”, thus the goal with these
diff --git a/output/posts/posts-list.html b/output/posts/posts-list.html index 0bea886..96a2c3b 100644 --- a/output/posts/posts-list.html +++ b/output/posts/posts-list.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +postsis to develop the skill of being able to deliver habitual high quality explanations as well as reinforcing the topic(s) learnt.Posts List @@ -214,16 +214,16 @@Updated: 2025-08-28 Thu 17:03+Updated: 2025-08-28 Thu 17:40Posts List
See the categories: Categories
--Posts:
-++Posts:
+Setup @@ -218,9 +218,9 @@Setup
--Introduction
-+-+Introduction
+Last updated:
@@ -235,9 +235,9 @@ This page will highlight thebuild-script.elused to generate this-The script
-+-+The script
+The script is as follows, at the start I have some metadata relating to the file, followed by package management,then the declaration of variables/functions and finally the
@@ -650,9 +650,9 @@ Created with %c on <a href=\"https://www.archlinux.org/\">Arch</a> &org-publish-project-alistwhich handles nearly all of the project generation instructions.-Publish Script
-++Publish Script
+-As the project is hosted on Github, I have created a small script that is able to push changes to the remote repository, which Cloudflare will automatically detect and rebuild the website:
diff --git a/output/sitemap.html b/output/sitemap.html index 5edffd0..9e326c0 100644 --- a/output/sitemap.html +++ b/output/sitemap.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +Sitemap @@ -214,7 +214,7 @@Updated: 2025-08-28 Thu 17:03+Updated: 2025-08-28 Thu 17:40-Sitemap
@@ -252,9 +252,9 @@Tag: books @@ -214,12 +214,12 @@Updated: 2025-08-28 Thu 17:03+Updated: 2025-08-28 Thu 17:40--Posts tagged books
-++Posts tagged books
+
Vertical Distance
-++Vertical Distance
+Conceptual Affinity
-++Conceptual Affinity
+Vertical Ordering
-++Vertical Ordering
+