Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

duplicate description #11793

Open
Rafnuss opened this issue Jan 5, 2025 · 5 comments
Open

duplicate description #11793

Rafnuss opened this issue Jan 5, 2025 · 5 comments
Labels
documentation Doc improvements & quarto-web

Comments

@Rafnuss
Copy link

Rafnuss commented Jan 5, 2025

What would you like to do?

Give feedback or suggest an improvement

Description

Duplicate description field in https://quarto.org/docs/reference/projects/books.html#section (also not the id section in the url does not match the heading title (book)

@Rafnuss Rafnuss added the documentation Doc improvements & quarto-web label Jan 5, 2025
@mcanouil
Copy link
Collaborator

mcanouil commented Jan 5, 2025

Could you be a bit more specific and tell us what is duplicated exactly?
What do you mean by "description"?

Note that there is no requirement that the section anchor matches with the section title.
References pages are automatically generated for your information.

@Rafnuss
Copy link
Author

Rafnuss commented Jan 5, 2025

Sorry, under the book section, in the list of fields, the field "description" appears twice. Once toward the top:
description: Description metadata for HTML version of book
And once just above favicon
description : Website description

@Rafnuss
Copy link
Author

Rafnuss commented Jan 5, 2025

Sorry, under the book section, in the list of fields, the field "description" appears twice. Once toward the top:

description: Description metadata for HTML version of book

And once just above favicon

description : Website description

Is that more clear?

@mcanouil
Copy link
Collaborator

mcanouil commented Jan 5, 2025

I see, the duplicate is the description item/key not in the "description column" of the table.

@mcanouil
Copy link
Collaborator

mcanouil commented Jan 5, 2025

As suspected, it's not entirely a duplicate: one comes from the base website schema and the other from book schema which is built upon website.

  • - id: base-website
    object:
    closed: true
    properties:
    title:
    string:
    description: "Website title"
    description:
    string:
    description: "Website description"
  • - id: book-schema
    schema:
    object:
    closed: true
    super:
    resolveRef: base-website
    properties:
    title:
    string:
    description: "Book title"
    subtitle:
    string:
    description: "Book subtitle"
    author:
    maybeArrayOf:
    anyOf: [string, object]
    description: "Author or authors of the book"
    date:
    string:
    description: "Book publication date"
    date-format:
    string:
    description: "Format string for dates in the book"
    abstract:
    string:
    description: "Book abstract"
    description:
    string:
    description: "Description metadata for HTML version of book"
    chapters:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Doc improvements & quarto-web
Projects
None yet
Development

No branches or pull requests

2 participants