Merge pull request #249 from oscar-system/enh/docstring_Polymake_jl

Enh/docstring polymake jl
oscar-system · Apr 13, 2020 · fd04c00 · fd04c00 · kalmarek · Apr 14, 2020
2 parents f84f4db + c68169d
commit fd04c00
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 7 deletions.
diff --git a/.github/workflows/runtests.yml b/.github/workflows/runtests.yml
@@ -7,10 +7,10 @@ jobs:
  runs-on: ${{ matrix.os }}
  strategy:
  matrix:
- julia-version: ['1.0', '1.3']
+ julia-version: ['1.0', '1.3', '1.4']
  os: [ubuntu-latest, macOS-latest]
  fail-fast: true
- 
+
  steps:
  - uses: actions/checkout@v1.0.0
  - name: "Set up Julia"
@@ -22,15 +22,15 @@ jobs:
  - uses: julia-actions/julia-uploadcodecov@latest
  env:
  CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
- 
+
  test-julia-nightly:
  runs-on: ${{ matrix.os }}
  strategy:
  matrix:
- julia-version: ['^1.4.0-rc1', 'nightly']
+ julia-version: ['nightly']
  os: [ubuntu-latest, macOS-latest]
  fail-fast: false
- 
+
  steps:
  - uses: actions/checkout@v1.0.0
  - name: "Set up Julia"

diff --git a/src/Polymake.jl b/src/Polymake.jl
@@ -1,3 +1,11 @@
+"""
+`Polymake.jl` is the Julia interface to `polymake`, an open source software for research in polyhedral geometry.
+
+For more information see:
+ > https://polymake.org/doku.php
+ >
+ > https://github.com/oscar-system/Polymake.jl
+"""
 module Polymake
 
 export @pm, @convert_to, visual

diff --git a/src/util.jl b/src/util.jl
@@ -30,9 +30,9 @@ function shell_execute(str::AbstractString)
 end
 
 function cite(;format=:bibtex)
- cite_str = split(shell_execute("""help "core/citation";""")[2], "\n\n")[2]
+ cite_str = match(r"(?<bibtex>@incollection.*\n (\s*\w*\s?= .*\n)+\s*\})", shell_execute("""help "core/citation";""").stdout)
  if format == :bibtex
- return cite_str
+ return print(cite_str[:bibtex])
  else
  throw("The only supported citation format is :bibtex")
  end