Skip to content

Restarting the issue #17 : request for revising the package document #92

Description

@yuanyang11510

Hi, I spent the entire afternoon struggling with the \titleclass{}{} command before I finally noticed the single sentence on the P. 11:

WARNING If you set or reset the class, you may need to redefine the format, too.

and the other sentence on the P. 5:

\titlespacing does not work with either \chapter and \part unless you change its
title format as well by means of \titleformat, the simple settings, or \titleclass.

I also came across the older issue #17, which describes the same problem I encountered today and the same discovery I made.

I think this confusion could be systematically avoided if the wording on these two pages were slightly revised. For example, it could explicitly state that:

“Using the command \titleclass{}{} alone for \part can cause problems and must be accompanied by the command \titleformat.”

It would also be helpful to place these warnings directly under each relevant command. In their current form, they seem like minor tips rather than warnings, which does not reflect their true importance.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions