Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Project to incorporate Frank Lutz's data #3192

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 13 additions & 0 deletions experimental/TransitiveSimplicialComplex/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# An example template for the experimental section

## Aims

This is an example for a file structure to set up a new package
in the experimental section. All files you find here are part of the
minimum requirements. See also the official Oscar documentation.

## Status

We plan to also provide a function to automatically copy this template
for you to start your own package.

8 changes: 8 additions & 0 deletions experimental/TransitiveSimplicialComplex/docs/doc.main
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# An example documentation

This is a sample text to outline the structure of the packages in the `Experimental` folder.
You can show docstrings like this:
```@docs
my_access_func(S::ExampleStruct)
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Add your new types, functions, and methods here.

mutable struct ExampleStruct
i::Int
end

@doc raw"""
my_access_func(S::ExampleStruct)

This is a dummy sample function to teach the use of docstrings.
"""
function my_access_func(S::ExampleStruct)
return S.i
end

4 changes: 4 additions & 0 deletions experimental/TransitiveSimplicialComplex/test/runtests.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
@testset "Experimental template tests" begin
S = Oscar.ExampleStruct(5)
@test 5 == Oscar.my_access_func(S)
end