|
78 | 78 | <div data-md-component="skip"> |
79 | 79 |
|
80 | 80 |
|
81 | | - <a href="#declaration" class="md-skip"> |
| 81 | + <a href="#rule-name" class="md-skip"> |
82 | 82 | Skip to content |
83 | 83 | </a> |
84 | 84 |
|
|
761 | 761 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> |
762 | 762 |
|
763 | 763 | <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"> |
764 | 774 | <a href="#declaration" class="md-nav__link"> |
765 | 775 | <span class="md-ellipsis"> |
766 | 776 | Declaration |
767 | 777 | </span> |
768 | 778 | </a> |
769 | 779 |
|
770 | 780 | </li> |
771 | | - |
772 | | - <li class="md-nav__item"> |
| 781 | + |
| 782 | + <li class="md-nav__item"> |
773 | 783 | <a href="#definition" class="md-nav__link"> |
774 | 784 | <span class="md-ellipsis"> |
775 | 785 | Definition |
776 | 786 | </span> |
777 | 787 | </a> |
778 | 788 |
|
779 | 789 | </li> |
780 | | - |
781 | | - <li class="md-nav__item"> |
| 790 | + |
| 791 | + <li class="md-nav__item"> |
782 | 792 | <a href="#class" class="md-nav__link"> |
783 | 793 | <span class="md-ellipsis"> |
784 | 794 | Class |
785 | 795 | </span> |
786 | 796 | </a> |
787 | 797 |
|
788 | 798 | </li> |
789 | | - |
790 | | - <li class="md-nav__item"> |
| 799 | + |
| 800 | + <li class="md-nav__item"> |
791 | 801 | <a href="#function" class="md-nav__link"> |
792 | 802 | <span class="md-ellipsis"> |
793 | 803 | Function |
794 | 804 | </span> |
795 | 805 | </a> |
796 | 806 |
|
797 | 807 | </li> |
798 | | - |
799 | | - <li class="md-nav__item"> |
| 808 | + |
| 809 | + <li class="md-nav__item"> |
800 | 810 | <a href="#identifier" class="md-nav__link"> |
801 | 811 | <span class="md-ellipsis"> |
802 | 812 | Identifier |
803 | 813 | </span> |
804 | 814 | </a> |
805 | 815 |
|
806 | 816 | </li> |
807 | | - |
808 | | - <li class="md-nav__item"> |
| 817 | + |
| 818 | + <li class="md-nav__item"> |
809 | 819 | <a href="#property" class="md-nav__link"> |
810 | 820 | <span class="md-ellipsis"> |
811 | 821 | Property |
812 | 822 | </span> |
813 | 823 | </a> |
814 | 824 |
|
815 | 825 | </li> |
816 | | - |
817 | | - <li class="md-nav__item"> |
| 826 | + |
| 827 | + <li class="md-nav__item"> |
818 | 828 | <a href="#variable" class="md-nav__link"> |
819 | 829 | <span class="md-ellipsis"> |
820 | 830 | Variable |
821 | 831 | </span> |
822 | 832 | </a> |
823 | 833 |
|
| 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 | + |
824 | 908 | </li> |
825 | 909 |
|
826 | 910 | </ul> |
|
864 | 948 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> |
865 | 949 |
|
866 | 950 | <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"> |
867 | 961 | <a href="#declaration" class="md-nav__link"> |
868 | 962 | <span class="md-ellipsis"> |
869 | 963 | Declaration |
870 | 964 | </span> |
871 | 965 | </a> |
872 | 966 |
|
873 | 967 | </li> |
874 | | - |
875 | | - <li class="md-nav__item"> |
| 968 | + |
| 969 | + <li class="md-nav__item"> |
876 | 970 | <a href="#definition" class="md-nav__link"> |
877 | 971 | <span class="md-ellipsis"> |
878 | 972 | Definition |
879 | 973 | </span> |
880 | 974 | </a> |
881 | 975 |
|
882 | 976 | </li> |
883 | | - |
884 | | - <li class="md-nav__item"> |
| 977 | + |
| 978 | + <li class="md-nav__item"> |
885 | 979 | <a href="#class" class="md-nav__link"> |
886 | 980 | <span class="md-ellipsis"> |
887 | 981 | Class |
888 | 982 | </span> |
889 | 983 | </a> |
890 | 984 |
|
891 | 985 | </li> |
892 | | - |
893 | | - <li class="md-nav__item"> |
| 986 | + |
| 987 | + <li class="md-nav__item"> |
894 | 988 | <a href="#function" class="md-nav__link"> |
895 | 989 | <span class="md-ellipsis"> |
896 | 990 | Function |
897 | 991 | </span> |
898 | 992 | </a> |
899 | 993 |
|
900 | 994 | </li> |
901 | | - |
902 | | - <li class="md-nav__item"> |
| 995 | + |
| 996 | + <li class="md-nav__item"> |
903 | 997 | <a href="#identifier" class="md-nav__link"> |
904 | 998 | <span class="md-ellipsis"> |
905 | 999 | Identifier |
906 | 1000 | </span> |
907 | 1001 | </a> |
908 | 1002 |
|
909 | 1003 | </li> |
910 | | - |
911 | | - <li class="md-nav__item"> |
| 1004 | + |
| 1005 | + <li class="md-nav__item"> |
912 | 1006 | <a href="#property" class="md-nav__link"> |
913 | 1007 | <span class="md-ellipsis"> |
914 | 1008 | Property |
915 | 1009 | </span> |
916 | 1010 | </a> |
917 | 1011 |
|
918 | 1012 | </li> |
919 | | - |
920 | | - <li class="md-nav__item"> |
| 1013 | + |
| 1014 | + <li class="md-nav__item"> |
921 | 1015 | <a href="#variable" class="md-nav__link"> |
922 | 1016 | <span class="md-ellipsis"> |
923 | 1017 | Variable |
924 | 1018 | </span> |
925 | 1019 | </a> |
926 | 1020 |
|
| 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 | + |
927 | 1095 | </li> |
928 | 1096 |
|
929 | 1097 | </ul> |
|
947 | 1115 |
|
948 | 1116 | <h1>Glossary</h1> |
949 | 1117 |
|
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">¶</a></h2> |
951 | 1121 | <h3 id="declaration">Declaration<a class="headerlink" href="#declaration" title="Permanent link">¶</a></h3> |
952 | 1122 | <p>Declaring that a class, function or property exists. The implementation details |
953 | 1123 | 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 |
982 | 1152 | <h3 id="variable">Variable<a class="headerlink" href="#variable" title="Permanent link">¶</a></h3> |
983 | 1153 | <p>A variable is a local-scoped property in most programming languages. However, |
984 | 1154 | 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">¶</a></h2> |
| 1156 | +<h3 id="add">Add<a class="headerlink" href="#add" title="Permanent link">¶</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">¶</a></h3> |
| 1159 | +<p>Reorganize the order of components.</p> |
| 1160 | +<h3 id="omit">Omit<a class="headerlink" href="#omit" title="Permanent link">¶</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">¶</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">¶</a></h3> |
| 1166 | +<p>Change the position of a component.</p> |
| 1167 | +<h3 id="remove">Remove<a class="headerlink" href="#remove" title="Permanent link">¶</a></h3> |
| 1168 | +<p>Take out the whole component from the codebase.</p> |
985 | 1169 |
|
986 | 1170 |
|
987 | 1171 |
|
|
0 commit comments