aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2023-03-24 10:12:58 +0100
committerGitHub <[email protected]>2023-03-24 09:12:58 +0000
commit16383bbed55f3fdea8958f013f92f4fe9550d8cb (patch)
treebe880e7ae00e21bfd9775923dcebdbf830c83b0a /docs
parent9dcf83f9b0b7353da6083da476d30dab74a52a50 (diff)
downloadfaker-16383bbed55f3fdea8958f013f92f4fe9550d8cb.tar.xz
faker-16383bbed55f3fdea8958f013f92f4fe9550d8cb.zip
docs: mark deprecated parameter options (#1962)
Diffstat (limited to 'docs')
-rw-r--r--docs/.vitepress/components/api-docs/method-parameters.vue14
1 files changed, 13 insertions, 1 deletions
diff --git a/docs/.vitepress/components/api-docs/method-parameters.vue b/docs/.vitepress/components/api-docs/method-parameters.vue
index ca3aef37..fbc28635 100644
--- a/docs/.vitepress/components/api-docs/method-parameters.vue
+++ b/docs/.vitepress/components/api-docs/method-parameters.vue
@@ -19,7 +19,13 @@ const props = defineProps<{ parameters: MethodParameter[] }>();
</thead>
<tbody>
<tr v-for="parameter of props.parameters" :key="parameter.name">
- <td>{{ parameter.name }}</td>
+ <td
+ :class="{
+ deprecated: parameter.description.includes('DEPRECATED'),
+ }"
+ >
+ {{ parameter.name }}
+ </td>
<td>{{ parameter.type }}</td>
<td>
<code v-if="parameter.default">{{ parameter.default }}</code>
@@ -30,3 +36,9 @@ const props = defineProps<{ parameters: MethodParameter[] }>();
</table>
</div>
</template>
+
+<style scoped>
+td.deprecated {
+ text-decoration: line-through;
+}
+</style>