sic: add page #5694

Waples · 2021-04-06T09:30:16Z

The page (if new), does not already exist in the repo.
The page is in the correct platform directory (common/, linux/, etc.)
The page has 8 or fewer examples.
The PR title conforms to the recommended templates.
The page follows the content guidelines.
The page description includes a link to documentation or a homepage (if applicable).

tldr-bot · 2021-04-06T09:30:39Z

The build for this PR failed with the following error(s):

pages/linux/sic.md:3: TLDR003 Descriptions should start with a capital letter
pages/linux/sic.md:7: TLDR102 Example description probably not properly annotated
pages/linux/sic.md:11: TLDR102 Example description probably not properly annotated
pages/linux/sic.md:15: TLDR102 Example description probably not properly annotated
pages/linux/sic.md:19: TLDR102 Example description probably not properly annotated
pages/linux/sic.md:23: TLDR102 Example description probably not properly annotated
pages/linux/sic.md:27: TLDR102 Example description probably not properly annotated

Please fix the error(s) and push again.

tldr-bot · 2021-04-06T09:31:17Z

The build for this PR failed with the following error(s):

pages/linux/sic.md:3: TLDR003 Descriptions should start with a capital letter
pages/linux/sic.md:7: TLDR102 Example description probably not properly annotated
pages/linux/sic.md:11: TLDR102 Example description probably not properly annotated
pages/linux/sic.md:15: TLDR102 Example description probably not properly annotated
pages/linux/sic.md:19: TLDR102 Example description probably not properly annotated
pages/linux/sic.md:23: TLDR102 Example description probably not properly annotated
pages/linux/sic.md:27: TLDR102 Example description probably not properly annotated

Please fix the error(s) and push again.

tldr-bot · 2021-04-06T09:32:38Z

The build for this PR failed with the following error(s):

pages/linux/sic.md:3: TLDR003 Descriptions should start with a capital letter

Please fix the error(s) and push again.

Waples · 2021-04-06T09:33:11Z

suckless doesn't use Capital letters. Can we get a pass on TLDR003 ?

tldr-bot · 2021-04-06T09:41:21Z

The build for this PR failed with the following error(s):

pages/linux/sic.md:3: TLDR003 Descriptions should start with a capital letter

Please fix the error(s) and push again.

tldr-bot · 2021-04-06T09:51:15Z

The build for this PR failed with the following error(s):

pages/linux/sic.md:3: TLDR003 Descriptions should start with a capital letter

Please fix the error(s) and push again.

waldyrious · 2021-04-06T10:19:09Z

suckless doesn't use Capital letters. Can we get a pass on TLDR003 ?

Do you mean that "sic" is meant to stand for "simple irc client", all in lowercase? I don't think we need to conform to stylistic preferences of the projects we document, as long as the content itself is accurate. We can accommodate stylization of names themselves (as we do e.g. with LaTeX), but the descriptions in tldr pages are meant to be useful and informative, not to represent the project's branding.

I would go with:

# sic
> Simple IRC client.

owenvoke · 2021-04-06T10:20:51Z

I think it should be fine to just use Simple instead of simple...

sbrl

Thanks for the new page, @Waples! I've left some comments below for you to review.

pages/linux/sic.md

sbrl · 2021-04-06T12:21:37Z

pages/linux/sic.md

+
+- Usage with highlighted alerts on mention of your username:
+
+`sic | awk '/username/ {printf "\a"}1'`


This example seems to demonstrate the usage of the awk command, rather than the sic command. Generally in tldr pages we try to keep pages focused on the command they are about.

No, this example demonstrates how you can highlight a message when your username is mentioned when using sic.

Yeah, I'm not sure if we should keep this example.

pages/linux/sic.md

Waples · 2021-04-06T12:25:20Z

Yes, sic stands literally for simple irc client, all in lower case @waldyrious. Fair enough, but I like to honor the title of the project/product at least. Simplistic; it's sic. (sometimes TLDR003 is not needed imo).

Co-authored-by: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>

tldr-bot · 2021-04-06T12:32:15Z

The build for this PR failed with the following error(s):

pages/linux/sic.md:3: TLDR003 Descriptions should start with a capital letter

Please fix the error(s) and push again.

Waples · 2021-04-06T12:32:52Z

@sbrl you should try out sic, it will make more sense ;]

pages/linux/sic.md

Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com>

tldr-bot · 2021-04-06T15:52:59Z

The build for this PR failed with the following error(s):

pages/linux/sic.md:3: TLDR003 Descriptions should start with a capital letter

Please fix the error(s) and push again.

bl-ue · 2021-04-06T17:08:08Z

Regarding the casing, I admit that I agree with @waldyrious's opinion. As he stated, we're not required to adhere to the projects particular formats, and as 'simple irc client' is merely a description, changing it to match our existing ~3000 pages is the best course of action. Over the years, there have been many such discussions about this exemption or that, but in the end, the simplest, approach most consistent with the rest of the pages is chosen, because otherwise the exceptions pile up and become very difficult to manage.

Waples · 2021-04-06T18:30:56Z

@bl-ue then what ya think about.... Suckless: sic / Suckless: sic, simple irc client ?

I've got more suckless things I wanna add I think, so what's yer thought hmmn?

Waples · 2021-04-06T18:31:41Z

simple irc client is also the name (hence sic)

bl-ue · 2021-04-07T12:24:16Z

@Waples:

I'd think that a user would mentally match sic with Simple IRC client, so I think that's all that's necessary
Also, that the tool is a suckless tool is made obvious by the link.

What do you think?

Waples · 2021-04-07T13:09:05Z

@bl-ue

Simple IRC client.

already changed that.

Shall i remove the link from the 2nd description line?

bl-ue · 2021-04-07T13:11:03Z

I would; doesn't seem that useful given it's on the very next line (albeit slightly dissimilar, I don't think it matters much though)

Waples · 2021-04-07T13:14:01Z

fixed

Waples · 2021-04-07T13:45:39Z

bump @sbrl

pages/linux/sic.md

waldyrious · 2021-04-07T13:51:04Z

@Waples thanks for your patience with our review comments! The page looks quite good now — I left just a few comments inline, please take a look.

Co-authored-by: Waldir Pimenta <waldyrious@gmail.com>

Waples · 2021-04-07T15:26:38Z

applied suggestions

waldyrious

LGTM — thanks again @Waples for the submission and patience! Since this already has two approvals, I'll go ahead and merge after I add my own.

The requested changes have been implemented.

sbrl

Sorry for not getting back to this. @Waples: That awk example was indeed showing highlighted messages, but it did not do so by calling sic with different arguments - hence it would be a better fit for a wider cheat sheet as opposed to a compact tldr page.

No need to send bump messages to get my attention - it was in my notifications list - I just haven't had time to return to this until now.

suckless-sic: init

041ef38

minor fix

fb23726

fix TLDR102

ffa8840

fix -k pass

761f7d3

fix -h host

a5a3ee9

waldyrious mentioned this pull request Apr 6, 2021

cmark: fix capitalization of "LaTeX" #5695

Merged

5 tasks

sbrl previously requested changes Apr 6, 2021

View reviewed changes

Update pages/linux/sic.md

6d0ed2e

Co-authored-by: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>

bl-ue added the new command Issues requesting creation of a new page. label Apr 6, 2021

bl-ue reviewed Apr 6, 2021

View reviewed changes

pages/linux/sic.md Outdated Show resolved Hide resolved

Update pages/linux/sic.md

b6b4c33

Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com>

conform to TDLR003

d42af7e

Waples requested review from sbrl and bl-ue April 7, 2021 10:43

improve command choices

426850e

fix description

805c576

bl-ue approved these changes Apr 7, 2021

View reviewed changes

owenvoke approved these changes Apr 7, 2021

View reviewed changes

waldyrious reviewed Apr 7, 2021

View reviewed changes

pages/linux/sic.md Outdated Show resolved Hide resolved

bl-ue changed the title ~~suckless-sic: add page~~ sic: add page Apr 7, 2021

waldyrious reviewed Apr 7, 2021

View reviewed changes

pages/linux/sic.md Outdated Show resolved Hide resolved

waldyrious reviewed Apr 7, 2021

View reviewed changes

pages/linux/sic.md Outdated Show resolved Hide resolved

Waples and others added 3 commits April 7, 2021 15:55

Update pages/linux/sic.md

b8279ff

Co-authored-by: Waldir Pimenta <waldyrious@gmail.com>

Update pages/linux/sic.md

ecba5d3

Co-authored-by: Waldir Pimenta <waldyrious@gmail.com>

Update pages/linux/sic.md

5f4ed57

Co-authored-by: Waldir Pimenta <waldyrious@gmail.com>

waldyrious approved these changes Apr 7, 2021

View reviewed changes

waldyrious merged commit 8830f26 into tldr-pages:master Apr 7, 2021

sbrl reviewed Apr 11, 2021

View reviewed changes

Waples deleted the suckless-sic branch April 13, 2021 08:17

bl-ue mentioned this pull request Apr 16, 2021

Add collaborator: @Waples #5774

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

sic: add page #5694

sic: add page #5694

Waples commented Apr 6, 2021

tldr-bot commented Apr 6, 2021

tldr-bot commented Apr 6, 2021

tldr-bot commented Apr 6, 2021

Waples commented Apr 6, 2021

tldr-bot commented Apr 6, 2021

tldr-bot commented Apr 6, 2021

waldyrious commented Apr 6, 2021

owenvoke commented Apr 6, 2021

sbrl left a comment

sbrl Apr 6, 2021

Waples Apr 6, 2021

bl-ue Apr 6, 2021

Waples commented Apr 6, 2021

tldr-bot commented Apr 6, 2021

Waples commented Apr 6, 2021

tldr-bot commented Apr 6, 2021

bl-ue commented Apr 6, 2021 •

edited

Loading

Waples commented Apr 6, 2021 •

edited

Loading

Waples commented Apr 6, 2021

bl-ue commented Apr 7, 2021

Waples commented Apr 7, 2021

bl-ue commented Apr 7, 2021 •

edited

Loading

Waples commented Apr 7, 2021

Waples commented Apr 7, 2021

waldyrious commented Apr 7, 2021

Waples commented Apr 7, 2021

waldyrious left a comment

sbrl left a comment


		- Usage with highlighted alerts on mention of your username:

		`sic \| awk '/username/ {printf "\a"}1'`

sic: add page #5694

sic: add page #5694

Conversation

Waples commented Apr 6, 2021

tldr-bot commented Apr 6, 2021

tldr-bot commented Apr 6, 2021

tldr-bot commented Apr 6, 2021

Waples commented Apr 6, 2021

tldr-bot commented Apr 6, 2021

tldr-bot commented Apr 6, 2021

waldyrious commented Apr 6, 2021

owenvoke commented Apr 6, 2021

sbrl left a comment

Choose a reason for hiding this comment

sbrl Apr 6, 2021

Choose a reason for hiding this comment

Waples Apr 6, 2021

Choose a reason for hiding this comment

bl-ue Apr 6, 2021

Choose a reason for hiding this comment

Waples commented Apr 6, 2021

tldr-bot commented Apr 6, 2021

Waples commented Apr 6, 2021

tldr-bot commented Apr 6, 2021

bl-ue commented Apr 6, 2021 • edited Loading

Waples commented Apr 6, 2021 • edited Loading

Waples commented Apr 6, 2021

bl-ue commented Apr 7, 2021

Waples commented Apr 7, 2021

bl-ue commented Apr 7, 2021 • edited Loading

Waples commented Apr 7, 2021

Waples commented Apr 7, 2021

waldyrious commented Apr 7, 2021

Waples commented Apr 7, 2021

waldyrious left a comment

Choose a reason for hiding this comment

sbrl left a comment

Choose a reason for hiding this comment

bl-ue commented Apr 6, 2021 •

edited

Loading

Waples commented Apr 6, 2021 •

edited

Loading

bl-ue commented Apr 7, 2021 •

edited

Loading