Skip to content

Commit 502843f

Browse files
committed
Deployed e6eebae with MkDocs version: 1.6.1
1 parent 8abbef8 commit 502843f

File tree

9 files changed

+702
-585
lines changed

9 files changed

+702
-585
lines changed

about/glossary/index.html

Lines changed: 210 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
<div data-md-component="skip">
7979

8080

81-
<a href="#declaration" class="md-skip">
81+
<a href="#rule-name" class="md-skip">
8282
Skip to content
8383
</a>
8484

@@ -761,66 +761,150 @@
761761
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
762762

763763
<li class="md-nav__item">
764+
<a href="#rule-name" class="md-nav__link">
765+
<span class="md-ellipsis">
766+
Rule name
767+
</span>
768+
</a>
769+
770+
<nav class="md-nav" aria-label="Rule name">
771+
<ul class="md-nav__list">
772+
773+
<li class="md-nav__item">
764774
<a href="#declaration" class="md-nav__link">
765775
<span class="md-ellipsis">
766776
Declaration
767777
</span>
768778
</a>
769779

770780
</li>
771-
772-
<li class="md-nav__item">
781+
782+
<li class="md-nav__item">
773783
<a href="#definition" class="md-nav__link">
774784
<span class="md-ellipsis">
775785
Definition
776786
</span>
777787
</a>
778788

779789
</li>
780-
781-
<li class="md-nav__item">
790+
791+
<li class="md-nav__item">
782792
<a href="#class" class="md-nav__link">
783793
<span class="md-ellipsis">
784794
Class
785795
</span>
786796
</a>
787797

788798
</li>
789-
790-
<li class="md-nav__item">
799+
800+
<li class="md-nav__item">
791801
<a href="#function" class="md-nav__link">
792802
<span class="md-ellipsis">
793803
Function
794804
</span>
795805
</a>
796806

797807
</li>
798-
799-
<li class="md-nav__item">
808+
809+
<li class="md-nav__item">
800810
<a href="#identifier" class="md-nav__link">
801811
<span class="md-ellipsis">
802812
Identifier
803813
</span>
804814
</a>
805815

806816
</li>
807-
808-
<li class="md-nav__item">
817+
818+
<li class="md-nav__item">
809819
<a href="#property" class="md-nav__link">
810820
<span class="md-ellipsis">
811821
Property
812822
</span>
813823
</a>
814824

815825
</li>
816-
817-
<li class="md-nav__item">
826+
827+
<li class="md-nav__item">
818828
<a href="#variable" class="md-nav__link">
819829
<span class="md-ellipsis">
820830
Variable
821831
</span>
822832
</a>
823833

834+
</li>
835+
836+
</ul>
837+
</nav>
838+
839+
</li>
840+
841+
<li class="md-nav__item">
842+
<a href="#rule-message" class="md-nav__link">
843+
<span class="md-ellipsis">
844+
Rule message
845+
</span>
846+
</a>
847+
848+
<nav class="md-nav" aria-label="Rule message">
849+
<ul class="md-nav__list">
850+
851+
<li class="md-nav__item">
852+
<a href="#add" class="md-nav__link">
853+
<span class="md-ellipsis">
854+
Add
855+
</span>
856+
</a>
857+
858+
</li>
859+
860+
<li class="md-nav__item">
861+
<a href="#arrange" class="md-nav__link">
862+
<span class="md-ellipsis">
863+
Arrange
864+
</span>
865+
</a>
866+
867+
</li>
868+
869+
<li class="md-nav__item">
870+
<a href="#omit" class="md-nav__link">
871+
<span class="md-ellipsis">
872+
Omit
873+
</span>
874+
</a>
875+
876+
</li>
877+
878+
<li class="md-nav__item">
879+
<a href="#put" class="md-nav__link">
880+
<span class="md-ellipsis">
881+
Put
882+
</span>
883+
</a>
884+
885+
</li>
886+
887+
<li class="md-nav__item">
888+
<a href="#move" class="md-nav__link">
889+
<span class="md-ellipsis">
890+
Move
891+
</span>
892+
</a>
893+
894+
</li>
895+
896+
<li class="md-nav__item">
897+
<a href="#remove" class="md-nav__link">
898+
<span class="md-ellipsis">
899+
Remove
900+
</span>
901+
</a>
902+
903+
</li>
904+
905+
</ul>
906+
</nav>
907+
824908
</li>
825909

826910
</ul>
@@ -864,66 +948,150 @@
864948
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
865949

866950
<li class="md-nav__item">
951+
<a href="#rule-name" class="md-nav__link">
952+
<span class="md-ellipsis">
953+
Rule name
954+
</span>
955+
</a>
956+
957+
<nav class="md-nav" aria-label="Rule name">
958+
<ul class="md-nav__list">
959+
960+
<li class="md-nav__item">
867961
<a href="#declaration" class="md-nav__link">
868962
<span class="md-ellipsis">
869963
Declaration
870964
</span>
871965
</a>
872966

873967
</li>
874-
875-
<li class="md-nav__item">
968+
969+
<li class="md-nav__item">
876970
<a href="#definition" class="md-nav__link">
877971
<span class="md-ellipsis">
878972
Definition
879973
</span>
880974
</a>
881975

882976
</li>
883-
884-
<li class="md-nav__item">
977+
978+
<li class="md-nav__item">
885979
<a href="#class" class="md-nav__link">
886980
<span class="md-ellipsis">
887981
Class
888982
</span>
889983
</a>
890984

891985
</li>
892-
893-
<li class="md-nav__item">
986+
987+
<li class="md-nav__item">
894988
<a href="#function" class="md-nav__link">
895989
<span class="md-ellipsis">
896990
Function
897991
</span>
898992
</a>
899993

900994
</li>
901-
902-
<li class="md-nav__item">
995+
996+
<li class="md-nav__item">
903997
<a href="#identifier" class="md-nav__link">
904998
<span class="md-ellipsis">
905999
Identifier
9061000
</span>
9071001
</a>
9081002

9091003
</li>
910-
911-
<li class="md-nav__item">
1004+
1005+
<li class="md-nav__item">
9121006
<a href="#property" class="md-nav__link">
9131007
<span class="md-ellipsis">
9141008
Property
9151009
</span>
9161010
</a>
9171011

9181012
</li>
919-
920-
<li class="md-nav__item">
1013+
1014+
<li class="md-nav__item">
9211015
<a href="#variable" class="md-nav__link">
9221016
<span class="md-ellipsis">
9231017
Variable
9241018
</span>
9251019
</a>
9261020

1021+
</li>
1022+
1023+
</ul>
1024+
</nav>
1025+
1026+
</li>
1027+
1028+
<li class="md-nav__item">
1029+
<a href="#rule-message" class="md-nav__link">
1030+
<span class="md-ellipsis">
1031+
Rule message
1032+
</span>
1033+
</a>
1034+
1035+
<nav class="md-nav" aria-label="Rule message">
1036+
<ul class="md-nav__list">
1037+
1038+
<li class="md-nav__item">
1039+
<a href="#add" class="md-nav__link">
1040+
<span class="md-ellipsis">
1041+
Add
1042+
</span>
1043+
</a>
1044+
1045+
</li>
1046+
1047+
<li class="md-nav__item">
1048+
<a href="#arrange" class="md-nav__link">
1049+
<span class="md-ellipsis">
1050+
Arrange
1051+
</span>
1052+
</a>
1053+
1054+
</li>
1055+
1056+
<li class="md-nav__item">
1057+
<a href="#omit" class="md-nav__link">
1058+
<span class="md-ellipsis">
1059+
Omit
1060+
</span>
1061+
</a>
1062+
1063+
</li>
1064+
1065+
<li class="md-nav__item">
1066+
<a href="#put" class="md-nav__link">
1067+
<span class="md-ellipsis">
1068+
Put
1069+
</span>
1070+
</a>
1071+
1072+
</li>
1073+
1074+
<li class="md-nav__item">
1075+
<a href="#move" class="md-nav__link">
1076+
<span class="md-ellipsis">
1077+
Move
1078+
</span>
1079+
</a>
1080+
1081+
</li>
1082+
1083+
<li class="md-nav__item">
1084+
<a href="#remove" class="md-nav__link">
1085+
<span class="md-ellipsis">
1086+
Remove
1087+
</span>
1088+
</a>
1089+
1090+
</li>
1091+
1092+
</ul>
1093+
</nav>
1094+
9271095
</li>
9281096

9291097
</ul>
@@ -947,7 +1115,9 @@
9471115

9481116
<h1>Glossary</h1>
9491117

950-
<p>This section hopes to clarify some ambiguous terms used in rule names.</p>
1118+
<p>This section hopes to clarify some ambiguous terms used in rule names and
1119+
messages.</p>
1120+
<h2 id="rule-name">Rule name<a class="headerlink" href="#rule-name" title="Permanent link">&para;</a></h2>
9511121
<h3 id="declaration">Declaration<a class="headerlink" href="#declaration" title="Permanent link">&para;</a></h3>
9521122
<p>Declaring that a class, function or property exists. The implementation details
9531123
are considered to be <a href="#definition">definition</a>.</p>
@@ -982,6 +1152,20 @@ <h3 id="property">Property<a class="headerlink" href="#property" title="Permanen
9821152
<h3 id="variable">Variable<a class="headerlink" href="#variable" title="Permanent link">&para;</a></h3>
9831153
<p>A variable is a local-scoped property in most programming languages. However,
9841154
in this library, a variable refers to a property and parameter.</p>
1155+
<h2 id="rule-message">Rule message<a class="headerlink" href="#rule-message" title="Permanent link">&para;</a></h2>
1156+
<h3 id="add">Add<a class="headerlink" href="#add" title="Permanent link">&para;</a></h3>
1157+
<p>Insert a new component to the codebase.</p>
1158+
<h3 id="arrange">Arrange<a class="headerlink" href="#arrange" title="Permanent link">&para;</a></h3>
1159+
<p>Reorganize the order of components.</p>
1160+
<h3 id="omit">Omit<a class="headerlink" href="#omit" title="Permanent link">&para;</a></h3>
1161+
<p>Exclude certain elements without altering the rest of the component.</p>
1162+
<h3 id="put">Put<a class="headerlink" href="#put" title="Permanent link">&para;</a></h3>
1163+
<p>Include certain elements in a component without altering the rest of the
1164+
component.</p>
1165+
<h3 id="move">Move<a class="headerlink" href="#move" title="Permanent link">&para;</a></h3>
1166+
<p>Change the position of a component.</p>
1167+
<h3 id="remove">Remove<a class="headerlink" href="#remove" title="Permanent link">&para;</a></h3>
1168+
<p>Take out the whole component from the codebase.</p>
9851169

9861170

9871171

0 commit comments

Comments
 (0)