Docs: guide on profiling: fix the title

[ulysses4ever]

Please read Github PR Conventions and then fill in one of these two templates.

---

Template B: This PR does not modify behaviour or interface

E.g. the PR only touches documentation or tests, does refactorings, etc.

Include the following checklist in your PR:

• Patches conform to the coding conventions.
• [N/A] Is this a PR that fixes CI? If so, it will need to be backported to older cabal release branches (ask maintainers for directions).

[geekosaur]

Seems like the file should be renamed as well….

[Kleidukos]

@malteneuss Does this align with the vision you had for this guide?

[jasagredo]

I would be a bit less succinct and say something like "How to configure a project for profiling" or "Configuring a project for profiling".

But the current title is also fine for me, so I'll approve

[ulysses4ever]

I would be a bit less succinct and say something like "How to configure a project for profiling" or "Configuring a project for profiling".

Thanks, I'm open for options. I am not a fan of the first because it's a little lengthy, and the second deviates from the pattern that's established in the guide section: everything starts from "How to" (maybe not a great decision but it should be applied or unapplied consistently). Let's see what @malteneuss and others has to say.

Seems like the file should be renamed as well….

I was being lazy, sorry! Fixed.

[malteneuss]

The title was chosen to be more beginner friendly and to be immediately understandable even when someone doesn't know the correct technical term "profiling", i.e. people who are more likely to need a guide. Imagine what you would search if you didn't know that term: probably "measure haskell performance" or similar. Still, the guide uses the term "profiling" enough times to be locatable via Google easily for someone who knows.

While "analyze .. performance" isn't technically correct yet, (e.g. we don't explain how to to interpret results), that could be added later (even by just referencing the optimization book or GHC guide). It's also a relatively short title. Alternatives could have been "How to setup Cabal to measure Haskell performance" if it wasn't so long.

[ulysses4ever]

While "analyze .. performance" isn't technically correct yet, (e.g. we don't explain how to to interpret results), that could be added later

Let's not get ahead of ourselves. Only when and if such an addition is implemented can we discuss a title that reflects that new content. Besides, @jasagredo and I argued that it's not Cabal Guide's job to teach people to interpret GHC profiles. So, I am doubtful that such an addition will even happen. Of course, others may rule otherwise.

The title was chosen to be more beginner friendly and to be immediately understandable even when someone doesn't know the correct technical term "profiling", i.e. people who are more likely to need a guide. Imagine what you would search if you didn't know that term: probably "measure haskell performance" or similar. Still, the guide uses the term "profiling" enough times to be locatable via Google easily for someone who knows.

I think Cabal Guide shouldn't be targeted at CS freshmen. The average reader is not very familiar with Haskell but is somewhat familiar with computer programming. So, I'd expect them to be aware of the notion of "profiling".

How about:

How to enable collection of performance statistics (profiling)

for the title?

[ulysses4ever]

(question for all)

[jasagredo]

I'm in favor of:

How to enable collection of performance statistics (profiling)

[malteneuss]

Good enough for me

[Kleidukos]

Good enough for me too

[Kleidukos]

@ulysses4ever Is everything alright with this PR? It blocks haskell/blog.haskell.org#9

[ulysses4ever]

Oh, I totally forgot about it. Let's fast-track.

[mergify]

This pull request has been removed from the queue for the following reason: pull request dequeued.

Pull request #10606 has been dequeued. The pull request rule doesn't match anymore. The following conditions don't match anymore:

• label=merge delay passed
• label=squash+merge me.

You should look at the reason for the failure and decide if the pull request needs to be fixed or if you want to requeue it.

If you want to requeue this pull request, you need to post a comment with the text: @mergifyio requeue

[ulysses4ever]

Actually, after re-reading the thread: it needs one more fixup, which I can do later today

[ulysses4ever]

@mergify rebase

[mergify]

rebase

✅ Branch has been successfully rebased

[ulysses4ever]

"Title underline too short." really???

[geekosaur]

Sounds like the Sphinx version of what I went through while trying to bend GHA to my will.