Skip to content

Commit 6be64f0

Browse files
johnbumgarnerjohnbumgarner
authored
UPDATED 05-23-2024
1 parent ff389e3 commit 6be64f0

File tree

1 file changed

+91
-23
lines changed

1 file changed

+91
-23
lines changed

‎docs/release-notes.md

+91-23
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,59 @@
55
This page provides information on all the <strong>WordHoard</strong> releases since inception.
66
</p>
77

8+
## Version 1.5.4
9+
10+
<strong>Date of Release:&nbsp; </strong> <i>05.23.2024</i>
11+
<br>
12+
<br>
13+
<strong>Purpose:&nbsp; </strong> <i>Code refactoring to improved modularization for readability and to reduce duplicated code related to error handling and querying.</i>
14+
15+
---
16+
17+
<p align="justify">
18+
Mutiple modules were refactored to improve readability and reduce duplicated code. The following modules had new Classes added to
19+
obtain parts of speech and data extract using <i> BeautifulSoup </i> .
20+
</p>
21+
22+
<ul>
23+
<li>antonyms</li>
24+
<li>dictionary</li>
25+
<li>synonyms</li>
26+
</ul>
27+
28+
29+
<p align="justify">
30+
The optional variable <i>sources</i> had been added to following modules. This variable allows you to refine the search sources to fit your requirements.
31+
</p>
32+
33+
<ul>
34+
<li>antonyms</li>
35+
<li>dictionary</li>
36+
<li>synonyms</li>
37+
</ul>
38+
39+
40+
<p align="justify">
41+
Type hinting was validated in all functions within all query modules and all utilities modules. Additionally, all parameter names in every function or call have been added. This improves code readability and reduces ambiguity when reviewing the code.
42+
</p>
43+
44+
<p align="justify">
45+
Cloudflare verification was modified with a timeout feature. Using <a href="https://www.collinsdictionary.com">Collins Dictionary</a> as a source can increase the runtime of <strong>WordHoard</strong> in the following modules.
46+
</p>
47+
48+
<ul>
49+
<li>antonyms</li>
50+
<li>dictionary</li>
51+
<li>synonyms</li>
52+
</ul>
53+
54+
855
## Version 1.5.3
956

10-
<strong>Date of Release: 03.21.2023</strong><br>
11-
<strong>Purpose: Code enhancements to improve performance when querying online repositories and to obtain part of speech category for word being queried.</strong>
57+
<strong>Date of Release:&nbsp; </strong> <i>03.21.2023</i>
58+
<br>
59+
<br>
60+
<strong>Purpose:&nbsp; </strong> <i>Code enhancements to improve performance when querying online repositories and to obtain part of speech category for word being queried.</i>
1261

1362
---
1463

@@ -37,8 +86,10 @@ This page provides information on all the <strong>WordHoard</strong> releases si
3786

3887
## Version 1.5.2
3988

40-
<strong>Date of Release: 02.12.2023</strong><br>
41-
<strong>Purpose: Code enhancements of the Translator classes and bug fix in the dictionary module</strong>
89+
<strong>Date of Release:&nbsp; </strong> <i>02.12.2023</i>
90+
<br>
91+
<br>
92+
<strong>Purpose:&nbsp; </strong> <i>Code enhancements of the Translator classes and bug fix in the dictionary module</i>
4293

4394
---
4495

@@ -49,8 +100,10 @@ Fixed the bug identified in the Issue 14: &nbsp <a href="https://github.com/john
49100

50101
## Version 1.5.2
51102

52-
<strong>Date of Release: 02.12.2023</strong><br>
53-
<strong>Purpose: Code enhancements of the Translator classes and bug fix in the dictionary module</strong>
103+
<strong>Date of Release:&nbsp; </strong> <i>02.12.2023</i>
104+
<br>
105+
<br>
106+
<strong>Purpose:&nbsp; </strong> <i>Code enhancements of the Translator classes and bug fix in the dictionary module</i>
54107

55108
---
56109

@@ -91,8 +144,10 @@ WordHoard.
91144

92145
## Version 1.5.1
93146

94-
<strong>Date of Release: 04.06.2022</strong><br>
95-
<strong>Purpose: Code enhancements (proxy and user agents)</strong>
147+
<strong>Date of Release:&nbsp; </strong> <i>04.06.2022</i>
148+
<br>
149+
<br>
150+
<strong>Purpose:&nbsp; </strong> <i>Code enhancements (proxy and user agents)</i>
96151

97152
---
98153

@@ -127,8 +182,10 @@ Selectable user agents capabilities were added to these modules:
127182

128183
## Version 1.5.0
129184

130-
<strong>Date of Release: 09.24.2021</strong><br>
131-
<strong>Purpose: Code enhancements (proxy and translation support)</strong>
185+
<strong>Date of Release:&nbsp; </strong> <i>09.24.2021</i>
186+
<br>
187+
<br>
188+
<strong>Purpose:&nbsp; </strong> <i>Code enhancements (proxy and translation support)</i>
132189

133190
---
134191

@@ -164,8 +221,10 @@ Multiple translation modules were also added to wordhoard. These modules are:
164221

165222
## Version 1.4.9
166223

167-
<strong>Date of Release: 09.07.2021</strong><br>
168-
<strong>Purpose: Added query rate limiting and additional exception handling</strong>
224+
<strong>Date of Release:&nbsp; </strong> <i>09.07.2021</i>
225+
<br>
226+
<br>
227+
<strong>Purpose:&nbsp; </strong> <i>Added query rate limiting and additional exception handling</i>
169228

170229
---
171230

@@ -176,8 +235,10 @@ Rate limiting was added to all modules that query online repositories. Additiona
176235

177236
## Version 1.4.8
178237

179-
<strong>Date of Release: 08.24.2021</strong><br>
180-
<strong>Purpose: Removed source and leftover debugging code</strong>
238+
<strong>Date of Release:&nbsp; </strong> <i>08.24.2021</i>
239+
<br>
240+
<br>
241+
<strong>Purpose:&nbsp; </strong> <i>Removed source and leftover debugging code</i>
181242

182243
---
183244

@@ -189,8 +250,10 @@ One of the original sources being queried was providing questionable synonyms an
189250

190251
## Version 1.4.7
191252

192-
<strong>Date of Release: 08.15.2021</strong><br>
193-
<strong>Purpose: Bugfix linked to changes in a page's navigational structure</strong>
253+
<strong>Date of Release:&nbsp; </strong> <i>08.15.2021</i>
254+
<br>
255+
<br>
256+
<strong>Purpose:</strong> <i>Bugfix linked to changes in a page's navigational structure</i>
194257

195258
---
196259

@@ -203,11 +266,12 @@ Version 1.4.7 was redesigned to handle this new navigational structure.
203266
</p>
204267

205268

206-
207269
## Version 1.4.6
208270

209-
<strong>Date of Release: 06.06.2021</strong><br>
210-
<strong>Purpose: Code redesign and enhancements</strong>
271+
<strong>Date of Release:&nbsp; </strong> <i>06.06.2021</i>
272+
<br>
273+
<br>
274+
<strong>Purpose:&nbsp; </strong> <i>Code redesign and enhancements</i>
211275

212276
---
213277

@@ -226,8 +290,10 @@ Console logging was disabled and all log entries are now written only to the fil
226290

227291
## Version 1.4.5
228292

229-
<strong>Date of Release: 05.12.2021</strong><br>
230-
<strong>Purpose: Code enhancements</strong>
293+
<strong>Date of Release:&nbsp; </strong> <i>05.12.2021</i>
294+
<br>
295+
<br>
296+
<strong>Purpose:&nbsp; </strong> <i>Code enhancements</i>
231297

232298
---
233299

@@ -238,8 +304,10 @@ Version 1.4.5 includes new modules to find hypernyms, hyponyms and homophones fo
238304

239305
## Version 1.2
240306

241-
<strong>Date of Release: 10.23.2020</strong><br>
242-
<strong>Purpose: Initial Release</strong>
307+
<strong>Date of Release:&nbsp; </strong> <i>10.23.2020</i>
308+
<br>
309+
<br>
310+
<strong>Purpose:&nbsp; </strong> <i>Initial Release</i>
243311

244312
---
245313

0 commit comments

Comments
 (0)