Add fun fact command #446

Atmois · 2024-08-22T16:26:16Z

Unfinished as going to add more fun facts.

Summary by Sourcery

Add a new command to the bot that delivers random fun facts about Linux, enhancing user engagement with interesting trivia.

New Features:

Introduce a new 'fun fact' command in the bot that provides users with random Linux-related fun facts.

sourcery-ai · 2024-08-22T16:26:24Z

Reviewer's Guide by Sourcery

This pull request adds a new 'fun fact' command to the bot, which provides users with random Linux-related trivia. The implementation includes a new Python file with a Fact class that inherits from commands.Cog, containing a list of Linux facts and a command to display a random fact using Discord embeds.

File-Level Changes

Change	Details	Files
Implement a new 'fun fact' command	Create a Fact class that inherits from commands.Cog Initialize a list of Linux-related fun facts Implement a hybrid command 'fact' with alias 'funfact' Use EmbedCreator to create an info embed for displaying the fact Set up an author field in the embed with a link to submit more facts Implement the setup function to add the Fact cog to the bot	`tux/cogs/fun/fact.py`

Tips

Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
Continue your discussion with Sourcery by replying directly to review comments.
You can change your review settings at any time by accessing your dashboard:
- Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
- Change the review language;
You can always contact us if you have any questions or feedback.

sourcery-ai

Hey @Atmois - I've reviewed your changes and they look great!

Here's what I looked at during the review

🟡 General issues: 2 issues found
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

sourcery-ai · 2024-08-22T16:27:30Z

tux/cogs/fun/fact.py

+            "Linux's 1.0 release was in March 1994.",
+            "Less than 1% of the latest kernel release includes code written by Linus Torvalds.",
+            "Linux is used by every major space programme in the world.",
+            "Approximatly 13.3% of the latest Linux kernel is made up of blank lines.",


suggestion (typo): Correct the spelling of 'Approximately' in the fact.

Ensuring accuracy in the facts presented enhances the credibility and professionalism of the bot.

sourcery-ai · 2024-08-22T16:27:30Z

tux/cogs/fun/fact.py

+            "95% of the Linux kernel is written in the C programming Language. Assembly language is the second most used language for Linux at 2.8%.",
+            "The first kernel version - Version 0.01 - contained about 10,000 lines of code.",
+            "96.3% of the top 1,000,000 web servers were reported to run on Linux.",
+            "In the early 2000's Steve Jobs - The then CEO of Apple - offered a job to Linux Torvalds which Torvalds declined.",


suggestion (typo): Correct 'Linux Torvalds' to 'Linus Torvalds' and consider rephrasing for clarity.

This fact contains a typo in Linus Torvalds' name and could be rephrased for better readability. Consider: 'In the early 2000s, Steve Jobs, then CEO of Apple, offered a job to Linus Torvalds, which Torvalds declined.'

Suggested change

"In the early 2000's Steve Jobs - The then CEO of Apple - offered a job to Linux Torvalds which Torvalds declined.",

"In the early 2000s, Steve Jobs, then CEO of Apple, offered a job to Linus Torvalds, which Torvalds declined.",

HikariNee · 2024-08-25T14:20:45Z

You can add this too.
https://news.ycombinator.com/item?id=8641073

sourcery-ai

Hey @Atmois - I've reviewed your changes - here's some feedback:

Overall Comments:

Consider completing the feature before submitting the PR, or provide more details about the remaining work in the PR description.
To improve scalability and maintainability, consider moving the list of facts to a separate file or database.

Here's what I looked at during the review

🟡 General issues: 2 issues found
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

tux/cogs/fun/fact.py

electron271 · 2024-08-26T20:12:01Z

@Atmois is it fine if i can unmark as draft or should i wait until you add more facts

Atmois · 2024-08-27T10:52:03Z

Go ahead

sourcery-ai

Hey @Atmois - I've reviewed your changes - here's some feedback:

Overall Comments:

Consider completing the feature before submitting a pull request, as indicated by the 'Unfinished' note in the description.
For better maintainability, consider moving the list of facts to a separate configuration file or database in the future, especially if you plan to add more facts.

Here's what I looked at during the review

🟡 General issues: 4 issues found
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

sourcery-ai · 2024-08-27T15:33:37Z

tux/cogs/fun/fact.py

+            "96.3% of the top 1,000,000 web servers were reported to run on Linux.",
+            "In the early 2000s, Steve Jobs, who at the time was the CEO of Apple, offered a job to Linus Torvalds to work on OSX which Torvalds declined.",
+            "Linus Torvalds said that he would have never created Linux if FreeBSD had been available at the time.",
+            "Linux is used by every major space programme in the world including NASA, SpaceX, and the European Space Agency.",


suggestion: Remove redundant fact

This fact is a duplicate of the one on line 8. Consider removing one of these instances to avoid repetition.

Suggested change

"Linux is used by every major space programme in the world including NASA, SpaceX, and the European Space Agency.",

# Removed duplicate fact about space programs using Linux

sourcery-ai · 2024-08-27T15:33:37Z

tux/cogs/fun/fact.py

+
+
+class Fact(commands.Cog):
+    def __init__(self, bot: commands.Bot) -> None:


suggestion (performance): Optimize fact selection for better distribution

Consider shuffling the facts list in the __init__ method and selecting facts from the first 75% of the list in the fact method. This approach would provide a good balance between randomness and ensuring all facts are seen before repeats occur.

def __init__(self, bot: commands.Bot) -> None: self.bot = bot self.facts = [] self.load_and_shuffle_facts() def load_and_shuffle_facts(self) -> None: self.facts = [...] # Load facts here random.shuffle(self.facts) self.fact_index = 0

sourcery-ai · 2024-08-27T15:33:37Z

tux/cogs/fun/fact.py

+        name="fact",
+        aliases=["funfact"],
+    )
+    async def fact(self, ctx: commands.Context[commands.Bot]) -> None:


suggestion: Improve or remove method comment

The current comment doesn't provide much additional information. Consider either removing it or expanding it to include more meaningful details about the method's behavior or purpose.

Suggested change

async def fact(self, ctx: commands.Context[commands.Bot]) -> None:

async def fact(self, ctx: commands.Context[commands.Bot]) -> None:

"""

Fetch and send a random fun fact to the user.

This command retrieves a fact from an external API or database

and posts it in the channel where the command was invoked.

"""

sourcery-ai · 2024-08-27T15:33:37Z

tux/cogs/fun/fact.py

+class Fact(commands.Cog):
+    def __init__(self, bot: commands.Bot) -> None:
+        self.bot = bot
+        self.facts = [


suggestion (performance): Consider scalability for fact storage

If there are plans to significantly expand the fact list in the future, you might want to consider a more scalable solution for storing and retrieving facts, such as loading from a file or database.

self.facts = self.load_facts_from_file('facts.json') def load_facts_from_file(self, filename): with open(filename, 'r') as file: return json.load(file)

Add fun fact command

8c779f8

Atmois self-assigned this Aug 22, 2024

Atmois added category: commands type: feature-request status: approved priority: low labels Aug 22, 2024

Atmois linked an issue Aug 22, 2024 that may be closed by this pull request

Get a random linux fun fact command #433

Closed

sourcery-ai bot reviewed Aug 22, 2024

View reviewed changes

grammer fixes

dc81d10

Atmois changed the title ~~Add fun fact command~~ [Unfinished] Add fun fact command Aug 22, 2024

Atmois marked this pull request as draft August 22, 2024 16:29

electron271 self-assigned this Aug 26, 2024

electron271 added 2 commits August 26, 2024 14:47

Merge branch 'main' into funfacts

44dcb5f

finish and fix fun facts command

2552bc0

electron271 marked this pull request as ready for review August 26, 2024 20:10

electron271 marked this pull request as draft August 26, 2024 20:11

sourcery-ai bot reviewed Aug 26, 2024

View reviewed changes

tux/cogs/fun/fact.py Show resolved Hide resolved

tux/cogs/fun/fact.py Outdated Show resolved Hide resolved

sourcery suggestion

2463358

Atmois changed the title ~~[Unfinished] Add fun fact command~~ Add fun fact command Aug 27, 2024

electron271 marked this pull request as ready for review August 27, 2024 15:32

electron271 approved these changes Aug 27, 2024

View reviewed changes

Merge branch 'main' into funfacts

33b1ec4

electron271 merged commit b7719f4 into main Aug 27, 2024

electron271 deleted the funfacts branch August 27, 2024 15:32

sourcery-ai bot reviewed Aug 27, 2024

View reviewed changes

	"In the early 2000's Steve Jobs - The then CEO of Apple - offered a job to Linux Torvalds which Torvalds declined.",
	"In the early 2000s, Steve Jobs, then CEO of Apple, offered a job to Linus Torvalds, which Torvalds declined.",

	"Linux is used by every major space programme in the world including NASA, SpaceX, and the European Space Agency.",
	# Removed duplicate fact about space programs using Linux



		class Fact(commands.Cog):
		def __init__(self, bot: commands.Bot) -> None:

-    async def fact(self, ctx: commands.Context[commands.Bot]) -> None:
+    async def fact(self, ctx: commands.Context[commands.Bot]) -> None:
+        """
+        Fetch and send a random fun fact to the user.
+        This command retrieves a fact from an external API or database
+        and posts it in the channel where the command was invoked.
+        """

Uh oh!

Add fun fact command #446

Add fun fact command #446

Uh oh!

Conversation

Atmois commented Aug 22, 2024 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Aug 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

File-Level Changes

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Aug 22, 2024

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Aug 22, 2024

Choose a reason for hiding this comment

Uh oh!

HikariNee commented Aug 25, 2024

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

electron271 commented Aug 26, 2024

Uh oh!

Atmois commented Aug 27, 2024

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Aug 27, 2024

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Aug 27, 2024

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Aug 27, 2024

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Aug 27, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Atmois commented Aug 22, 2024 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Aug 22, 2024 •

edited

Loading