77< head >
88< meta charset ="utf-8 ">
99< meta name ="viewport " content ="width=device-width, initial-scale=1, minimum-scale=1 " />
10- < meta name ="generator " content ="pdoc 0.9.1 " />
10+ < meta name ="generator " content ="pdoc 0.10.0 " />
1111< title > continuous_delivery_scripts.assert_news API documentation</ title >
1212< meta name ="description " content ="Checks if valid news files are created for changes in the project. " />
1313< link rel ="preload stylesheet " as ="style " href ="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css " integrity ="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs= " crossorigin >
@@ -290,7 +290,7 @@ <h2 id="args">Args</h2>
290290</ details >
291291</ dd >
292292< dt id ="continuous_delivery_scripts.assert_news.main "> < code class ="name flex ">
293- < span > def < span class ="ident "> main</ span > </ span > (< span > ) ‑> NoneType </ span >
293+ < span > def < span class ="ident "> main</ span > </ span > (< span > ) ‑> None </ span >
294294</ code > </ dt >
295295< dd >
296296< div class ="desc "> < p > Asserts the new PR comprises at least one news file and it adheres to the required standard.</ p > </ div >
@@ -329,7 +329,7 @@ <h2 id="args">Args</h2>
329329</ details >
330330</ dd >
331331< dt id ="continuous_delivery_scripts.assert_news.validate_news_file "> < code class ="name flex ">
332- < span > def < span class ="ident "> validate_news_file</ span > </ span > (< span > absolute_path: Union[pathlib.Path, str]) ‑> NoneType </ span >
332+ < span > def < span class ="ident "> validate_news_file</ span > </ span > (< span > absolute_path: Union[pathlib.Path, str]) ‑> None </ span >
333333</ code > </ dt >
334334< dd >
335335< div class ="desc "> < p > Applies NewsFileValidator validation logic to news file.</ p > </ div >
@@ -343,7 +343,7 @@ <h2 id="args">Args</h2>
343343</ details >
344344</ dd >
345345< dt id ="continuous_delivery_scripts.assert_news.validate_news_files "> < code class ="name flex ">
346- < span > def < span class ="ident "> validate_news_files</ span > </ span > (< span > git: < a title ="continuous_delivery_scripts.utils.git_helpers.GitWrapper " href ="utils/git_helpers.html#continuous_delivery_scripts.utils.git_helpers.GitWrapper "> GitWrapper</ a > , root_dir: str, news_dir: str) ‑> NoneType </ span >
346+ < span > def < span class ="ident "> validate_news_files</ span > </ span > (< span > git: < a title ="continuous_delivery_scripts.utils.git_helpers.GitWrapper " href ="utils/git_helpers.html#continuous_delivery_scripts.utils.git_helpers.GitWrapper "> GitWrapper</ a > , root_dir: str, news_dir: str) ‑> None </ span >
347347</ code > </ dt >
348348< dd >
349349< div class ="desc "> < p > Checks that news files exist and pass validation checks.</ p >
@@ -433,7 +433,7 @@ <h2 id="args">Args</h2>
433433< h3 > Methods</ h3 >
434434< dl >
435435< dt id ="continuous_delivery_scripts.assert_news.NewsFileValidator.validate "> < code class ="name flex ">
436- < span > def < span class ="ident "> validate</ span > </ span > (< span > self) ‑> NoneType </ span >
436+ < span > def < span class ="ident "> validate</ span > </ span > (< span > self) ‑> None </ span >
437437</ code > </ dt >
438438< dd >
439439< div class ="desc "> < p > Runs all validators.</ p > </ div >
@@ -449,7 +449,7 @@ <h3>Methods</h3>
449449</ details >
450450</ dd >
451451< dt id ="continuous_delivery_scripts.assert_news.NewsFileValidator.validate_file_contents "> < code class ="name flex ">
452- < span > def < span class ="ident "> validate_file_contents</ span > </ span > (< span > self) ‑> NoneType </ span >
452+ < span > def < span class ="ident "> validate_file_contents</ span > </ span > (< span > self) ‑> None </ span >
453453</ code > </ dt >
454454< dd >
455455< div class ="desc "> < p > Ensures the news file is not empty and not longer than one line.</ p > </ div >
@@ -467,7 +467,7 @@ <h3>Methods</h3>
467467</ details >
468468</ dd >
469469< dt id ="continuous_delivery_scripts.assert_news.NewsFileValidator.validate_file_name "> < code class ="name flex ">
470- < span > def < span class ="ident "> validate_file_name</ span > </ span > (< span > self) ‑> NoneType </ span >
470+ < span > def < span class ="ident "> validate_file_name</ span > </ span > (< span > self) ‑> None </ span >
471471</ code > </ dt >
472472< dd >
473473< div class ="desc "> < p > Ensures the news file follows the naming rules.</ p > </ div >
@@ -525,7 +525,7 @@ <h4><code><a title="continuous_delivery_scripts.assert_news.NewsFileValidator" h
525525</ nav >
526526</ main >
527527< footer id ="footer ">
528- < p > Generated by < a href ="https://pdoc3.github.io/pdoc "> < cite > pdoc</ cite > 0.9.1 </ a > .</ p >
528+ < p > Generated by < a href ="https://pdoc3.github.io/pdoc " title =" pdoc: Python API documentation generator " > < cite > pdoc</ cite > 0.10.0 </ a > .</ p >
529529</ footer >
530530</ body >
531531</ html >
0 commit comments