in reply to Re^3: RFC - Documentation Review
in thread Please review documentation of my AI::Embedding module

Thank you for the amazingly complete answer as usual Ken

Those are the files you should have in front of you (albeit in a different parent directory). Here's what you should do

That is indeed what I have :)

However, I didn't use export. Instead I used make, make test followed by make disttest. After that, I copied the two META files from the test path to the root directory.
Is that the same as export does?

I did it that way following the instructions in Re: What do I use to release a module to CPAN for the first time?

You have two subroutines in your module, test & test_embedding, which are not documented in your POD: add appropriate documentation

As I said in the original question, the second raw_embedding in the documentation is actually test_embedding. So the documentation exists for this.

I am having problems getting a private method working and test is a method to...erm...test it... It doesn't matter until multiple API providers are added so I've decided to leave that problem for now and get the module released. Then I will come back to solving the bug which will probably be yet another question for The Monastery!

You are under no obligation to use that directly

Ah! That's a relief...
I was considering looking for an alternative to Module::Starter (another question!) but perhaps I don't need to after all.

Replies are listed 'Best First'.
Re^5: RFC - Documentation Review
by kcott (Archbishop) on Jun 05, 2023 at 00:37 UTC
    "... I didn't use export. ... Is that the same as export does?"

    export is a shell command that adds a variable and its value to your environment; this will be picked up by subsequent processes. You'll probably have a lot of variables in your environment already. Try these: 

    $ env | sort | less

$ perl -E 'say for sort keys %ENV' | less

    [download]

    Your author tests contain: 

    unless ( $ENV{RELEASE_TESTING} ) {
    plan( skip_all => "Author tests not required for installation" );
}

    [download]

    `export RELEASE_TESTING=1` results in $ENV{RELEASE_TESTING} having a TRUE value: your author tests will now be run.

    "I did it that way following the instructions in ..."

    Step 6 has: "Now you run all your tests ...".

    If you don't set RELEASE_TESTING to a TRUE value, all your tests will not be run.

    — Ken

[reply]
[d/l]
[select]
      export is a shell command that adds a variable and its value to your environment

      Ah!
      I'm on Windows, so it is set instead!

[reply]
[d/l]

        > I'm on Windows, so it is set instead!

        Unless you're using PowerShell :) ... when it is: $env:RELEASE_TESTING=1

        Update: you might try using cygwin (as it seems kcott does to get that Linux feeling on Windows :)

[reply]
[d/l]
[select]

In Section Meditations